AyeCode / invoicing

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( strtotime( $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( strtotime( $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/payments/class-getpaid-checkout.php

Indentation +310 added lines, -310 removed lines

@@ -12,185 +12,185 @@ 
  */
 class GetPaid_Checkout {
 
-	/**
-	 * @var GetPaid_Payment_Form_Submission
-	 */
-	protected $payment_form_submission;
-
-	/**
-	 * Class constructor.
-	 *
-	 * @param GetPaid_Payment_Form_Submission $submission
-	 */
-	public function __construct( $submission ) {
-		$this->payment_form_submission = $submission;
-	}
-
-	/**
-	 * Processes the checkout.
-	 *
-	 */
-	public function process_checkout() {
-
-		// Validate the submission.
-		$this->validate_submission();
-
-		// Prepare the invoice.
-		$items    = $this->get_submission_items();
-		$invoice  = $this->get_submission_invoice();
-		$invoice  = $this->process_submission_invoice( $invoice, $items );
-		$prepared = $this->prepare_submission_data_for_saving();
-
-		$this->prepare_billing_info( $invoice );
-
-		$shipping   = $this->prepare_shipping_info( $invoice );
-
-		// Save the invoice.
-		$invoice->set_is_viewed( true );
-		$invoice->recalculate_total();
+    /**
+     * @var GetPaid_Payment_Form_Submission
+     */
+    protected $payment_form_submission;
+
+    /**
+     * Class constructor.
+     *
+     * @param GetPaid_Payment_Form_Submission $submission
+     */
+    public function __construct( $submission ) {
+        $this->payment_form_submission = $submission;
+    }
+
+    /**
+     * Processes the checkout.
+     *
+     */
+    public function process_checkout() {
+
+        // Validate the submission.
+        $this->validate_submission();
+
+        // Prepare the invoice.
+        $items    = $this->get_submission_items();
+        $invoice  = $this->get_submission_invoice();
+        $invoice  = $this->process_submission_invoice( $invoice, $items );
+        $prepared = $this->prepare_submission_data_for_saving();
+
+        $this->prepare_billing_info( $invoice );
+
+        $shipping   = $this->prepare_shipping_info( $invoice );
+
+        // Save the invoice.
+        $invoice->set_is_viewed( true );
+        $invoice->recalculate_total();
         $invoice->save();
 
-		do_action( 'getpaid_checkout_invoice_updated', $invoice );
+        do_action( 'getpaid_checkout_invoice_updated', $invoice );
 
-		// Send to the gateway.
-		$this->post_process_submission( $invoice, $prepared, $shipping );
-	}
+        // Send to the gateway.
+        $this->post_process_submission( $invoice, $prepared, $shipping );
+    }
 
-	/**
-	 * Validates the submission.
-	 *
-	 */
-	protected function validate_submission() {
+    /**
+     * Validates the submission.
+     *
+     */
+    protected function validate_submission() {
 
-		$submission = $this->payment_form_submission;
-		$data       = $submission->get_data();
+        $submission = $this->payment_form_submission;
+        $data       = $submission->get_data();
 
-		// Do we have an error?
+        // Do we have an error?
         if ( ! empty( $submission->last_error ) ) {
-			wp_send_json_error( $submission->last_error );
+            wp_send_json_error( $submission->last_error );
         }
 
-		// We need a billing email.
+        // We need a billing email.
         if ( ! $submission->has_billing_email() ) {
             wp_send_json_error( __( 'Provide a valid billing email.', 'invoicing' ) );
-		}
+        }
 
-		// Non-recurring gateways should not be allowed to process recurring invoices.
-		if ( $submission->should_collect_payment_details() && $submission->has_recurring && ! wpinv_gateway_support_subscription( $data['wpi-gateway'] ) ) {
-			wp_send_json_error( __( 'The selected payment gateway does not support subscription payments.', 'invoicing' ) );
-		}
+        // Non-recurring gateways should not be allowed to process recurring invoices.
+        if ( $submission->should_collect_payment_details() && $submission->has_recurring && ! wpinv_gateway_support_subscription( $data['wpi-gateway'] ) ) {
+            wp_send_json_error( __( 'The selected payment gateway does not support subscription payments.', 'invoicing' ) );
+        }
 
-		// Ensure the gateway is active.
-		if ( $submission->should_collect_payment_details() && ! wpinv_is_gateway_active( $data['wpi-gateway'] ) ) {
-			wp_send_json_error( __( 'The selected payment gateway is not active', 'invoicing' ) );
-		}
+        // Ensure the gateway is active.
+        if ( $submission->should_collect_payment_details() && ! wpinv_is_gateway_active( $data['wpi-gateway'] ) ) {
+            wp_send_json_error( __( 'The selected payment gateway is not active', 'invoicing' ) );
+        }
 
-		// Clear any existing errors.
-		wpinv_clear_errors();
+        // Clear any existing errors.
+        wpinv_clear_errors();
 
-		// Allow themes and plugins to hook to errors
-		do_action( 'getpaid_checkout_error_checks', $submission );
+        // Allow themes and plugins to hook to errors
+        do_action( 'getpaid_checkout_error_checks', $submission );
 
-		// Do we have any errors?
+        // Do we have any errors?
         if ( wpinv_get_errors() ) {
             wp_send_json_error( getpaid_get_errors_html() );
-		}
+        }
 
-	}
+    }
 
-	/**
-	 * Retrieves submission items.
-	 *
-	 * @return GetPaid_Form_Item[]
-	 */
-	protected function get_submission_items() {
+    /**
+     * Retrieves submission items.
+     *
+     * @return GetPaid_Form_Item[]
+     */
+    protected function get_submission_items() {
 
-		$items = $this->payment_form_submission->get_items();
+        $items = $this->payment_form_submission->get_items();
 
         // Ensure that we have items.
         if ( empty( $items ) && ! $this->payment_form_submission->has_fees() ) {
             wp_send_json_error( __( 'Please provide at least one item or amount.', 'invoicing' ) );
-		}
-
-		return $items;
-	}
-
-	/**
-	 * Retrieves submission invoice.
-	 *
-	 * @return WPInv_Invoice
-	 */
-	protected function get_submission_invoice() {
-		$submission = $this->payment_form_submission;
-
-		if ( ! $submission->has_invoice() ) {
-			$invoice = new WPInv_Invoice();
-			$invoice->set_created_via( 'payment_form' );
-			return $invoice;
         }
 
-		$invoice = $submission->get_invoice();
+        return $items;
+    }
+
+    /**
+     * Retrieves submission invoice.
+     *
+     * @return WPInv_Invoice
+     */
+    protected function get_submission_invoice() {
+        $submission = $this->payment_form_submission;
 
-		// Make sure that it is neither paid or refunded.
-		if ( $invoice->is_paid() || $invoice->is_refunded() ) {
-			wp_send_json_error( __( 'This invoice has already been paid for.', 'invoicing' ) );
-		}
+        if ( ! $submission->has_invoice() ) {
+            $invoice = new WPInv_Invoice();
+            $invoice->set_created_via( 'payment_form' );
+            return $invoice;
+        }
 
-		return $invoice;
-	}
+        $invoice = $submission->get_invoice();
 
-	/**
-	 * Processes the submission invoice.
-	 *
-	 * @param WPInv_Invoice $invoice
-	 * @param GetPaid_Form_Item[] $items
-	 * @return WPInv_Invoice
-	 */
-	protected function process_submission_invoice( $invoice, $items ) {
+        // Make sure that it is neither paid or refunded.
+        if ( $invoice->is_paid() || $invoice->is_refunded() ) {
+            wp_send_json_error( __( 'This invoice has already been paid for.', 'invoicing' ) );
+        }
 
-		$submission = $this->payment_form_submission;
+        return $invoice;
+    }
 
-		// Set-up the invoice details.
-		$invoice->set_email( sanitize_email( $submission->get_billing_email() ) );
-		$invoice->set_user_id( $this->get_submission_customer() );
-		$invoice->set_submission_id( $submission->id );
-		$invoice->set_payment_form( absint( $submission->get_payment_form()->get_id() ) );
+    /**
+     * Processes the submission invoice.
+     *
+     * @param WPInv_Invoice $invoice
+     * @param GetPaid_Form_Item[] $items
+     * @return WPInv_Invoice
+     */
+    protected function process_submission_invoice( $invoice, $items ) {
+
+        $submission = $this->payment_form_submission;
+
+        // Set-up the invoice details.
+        $invoice->set_email( sanitize_email( $submission->get_billing_email() ) );
+        $invoice->set_user_id( $this->get_submission_customer() );
+        $invoice->set_submission_id( $submission->id );
+        $invoice->set_payment_form( absint( $submission->get_payment_form()->get_id() ) );
         $invoice->set_items( $items );
         $invoice->set_fees( $submission->get_fees() );
         $invoice->set_taxes( $submission->get_taxes() );
-		$invoice->set_discounts( $submission->get_discounts() );
-		$invoice->set_gateway( $submission->get_field( 'wpi-gateway' ) );
-		$invoice->set_currency( $submission->get_currency() );
+        $invoice->set_discounts( $submission->get_discounts() );
+        $invoice->set_gateway( $submission->get_field( 'wpi-gateway' ) );
+        $invoice->set_currency( $submission->get_currency() );
 
-		if ( $submission->has_shipping() ) {
-			$invoice->set_shipping( $submission->get_shipping() );
-		}
+        if ( $submission->has_shipping() ) {
+            $invoice->set_shipping( $submission->get_shipping() );
+        }
 
-		$address_confirmed = $submission->get_field( 'confirm-address' );
-		$invoice->set_address_confirmed( ! empty( $address_confirmed ) );
+        $address_confirmed = $submission->get_field( 'confirm-address' );
+        $invoice->set_address_confirmed( ! empty( $address_confirmed ) );
 
-		if ( $submission->has_discount_code() ) {
+        if ( $submission->has_discount_code() ) {
             $invoice->set_discount_code( $submission->get_discount_code() );
-		}
-
-		getpaid_maybe_add_default_address( $invoice );
-		return $invoice;
-	}
-
-	/**
-	 * Retrieves the submission's customer.
-	 *
-	 * @return int The customer id.
-	 */
-	protected function get_submission_customer() {
-		$submission = $this->payment_form_submission;
-
-		// If this is an existing invoice...
-		if ( $submission->has_invoice() ) {
-			return $submission->get_invoice()->get_user_id();
-		}
-
-		// (Maybe) create the user.
+        }
+
+        getpaid_maybe_add_default_address( $invoice );
+        return $invoice;
+    }
+
+    /**
+     * Retrieves the submission's customer.
+     *
+     * @return int The customer id.
+     */
+    protected function get_submission_customer() {
+        $submission = $this->payment_form_submission;
+
+        // If this is an existing invoice...
+        if ( $submission->has_invoice() ) {
+            return $submission->get_invoice()->get_user_id();
+        }
+
+        // (Maybe) create the user.
         $user = get_current_user_id();
 
         if ( empty( $user ) ) {
@@ -198,16 +198,16 @@ 
         }
 
         if ( empty( $user ) ) {
-			$name = array( $submission->get_field( 'wpinv_first_name', 'billing' ), $submission->get_field( 'wpinv_last_name', 'billing' ) );
-			$name = implode( '', array_filter( $name ) );
+            $name = array( $submission->get_field( 'wpinv_first_name', 'billing' ), $submission->get_field( 'wpinv_last_name', 'billing' ) );
+            $name = implode( '', array_filter( $name ) );
             $user = wpinv_create_user( $submission->get_billing_email(), $name );
 
-			// (Maybe) send new user notification.
-			$should_send_notification = wpinv_get_option( 'disable_new_user_emails' );
-			if ( ! empty( $user ) && is_numeric( $user ) && apply_filters( 'getpaid_send_new_user_notification', empty( $should_send_notification ), $user ) ) {
-				wp_send_new_user_notifications( $user, 'user' );
-			}
-		}
+            // (Maybe) send new user notification.
+            $should_send_notification = wpinv_get_option( 'disable_new_user_emails' );
+            if ( ! empty( $user ) && is_numeric( $user ) && apply_filters( 'getpaid_send_new_user_notification', empty( $should_send_notification ), $user ) ) {
+                wp_send_new_user_notifications( $user, 'user' );
+            }
+        }
 
         if ( is_wp_error( $user ) ) {
             wp_send_json_error( $user->get_error_message() );
@@ -215,49 +215,49 @@ 
 
         if ( is_numeric( $user ) ) {
             return $user;
-		}
+        }
 
-		return $user->ID;
+        return $user->ID;
 
-	}
+    }
 
-	/**
+    /**
      * Prepares submission data for saving to the database.
      *
-	 * @return array
+     * @return array
      */
     public function prepare_submission_data_for_saving() {
 
-		$submission = $this->payment_form_submission;
+        $submission = $this->payment_form_submission;
 
-		// Prepared submission details.
+        // Prepared submission details.
         $prepared = array(
-			'all'  => array(),
-			'meta' => array(),
-		);
+            'all'  => array(),
+            'meta' => array(),
+        );
 
         // Raw submission details.
-		$data     = $submission->get_data();
+        $data     = $submission->get_data();
 
-		// Loop through the submitted details.
+        // Loop through the submitted details.
         foreach ( $submission->get_payment_form()->get_elements() as $field ) {
 
-			// Skip premade fields.
+            // Skip premade fields.
             if ( ! empty( $field['premade'] ) ) {
                 continue;
             }
 
-			// Ensure address is provided.
-			if ( 'address' === $field['type'] ) {
+            // Ensure address is provided.
+            if ( 'address' === $field['type'] ) {
                 $address_type = isset( $field['address_type'] ) && 'shipping' === $field['address_type'] ? 'shipping' : 'billing';
 
-				foreach ( $field['fields'] as $address_field ) {
+                foreach ( $field['fields'] as $address_field ) {
 
-					if ( ! empty( $address_field['visible'] ) && ! empty( $address_field['required'] ) && '' === trim( $_POST[ $address_type ][ $address_field['name'] ] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Missing
-						wp_send_json_error( __( 'Please fill all required fields.', 'invoicing' ) );
-					}
-			}
-		}
+                    if ( ! empty( $address_field['visible'] ) && ! empty( $address_field['required'] ) && '' === trim( $_POST[ $address_type ][ $address_field['name'] ] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Missing
+                        wp_send_json_error( __( 'Please fill all required fields.', 'invoicing' ) );
+                    }
+            }
+        }
 
             // If it is required and not set, abort.
             if ( ! $submission->is_required_field_set( $field ) ) {
@@ -267,31 +267,31 @@ 
             // Handle misc fields.
             if ( isset( $data[ $field['id'] ] ) ) {
 
-				// Uploads.
-				if ( 'file_upload' === $field['type'] ) {
-					$max_file_num = empty( $field['max_file_num'] ) ? 1 : absint( $field['max_file_num'] );
+                // Uploads.
+                if ( 'file_upload' === $field['type'] ) {
+                    $max_file_num = empty( $field['max_file_num'] ) ? 1 : absint( $field['max_file_num'] );
 
-					if ( count( $data[ $field['id'] ] ) > $max_file_num ) {
-						wp_send_json_error( __( 'Maximum number of allowed files exceeded.', 'invoicing' ) );
-					}
+                    if ( count( $data[ $field['id'] ] ) > $max_file_num ) {
+                        wp_send_json_error( __( 'Maximum number of allowed files exceeded.', 'invoicing' ) );
+                    }
 
-					$value = array();
+                    $value = array();
 
-					foreach ( $data[ $field['id'] ] as $url => $name ) {
-						$value[] = sprintf(
-							'<a href="%s" target="_blank">%s</a>',
-							esc_url_raw( $url ),
-							esc_html( $name )
-						);
-					}
+                    foreach ( $data[ $field['id'] ] as $url => $name ) {
+                        $value[] = sprintf(
+                            '<a href="%s" target="_blank">%s</a>',
+                            esc_url_raw( $url ),
+                            esc_html( $name )
+                        );
+                    }
 
-					$value = implode( ' | ', $value );
+                    $value = implode( ' | ', $value );
 
-				} elseif ( 'checkbox' === $field['type'] ) {
-					$value = ! empty( $data[ $field['id'] ] ) ? __( 'Yes', 'invoicing' ) : __( 'No', 'invoicing' );
-				} else {
-					$value = wp_kses_post( $data[ $field['id'] ] );
-				}
+                } elseif ( 'checkbox' === $field['type'] ) {
+                    $value = ! empty( $data[ $field['id'] ] ) ? __( 'Yes', 'invoicing' ) : __( 'No', 'invoicing' );
+                } else {
+                    $value = wp_kses_post( $data[ $field['id'] ] );
+                }
 
                 $label = $field['id'];
 
@@ -299,192 +299,192 @@ 
                     $label = $field['label'];
                 }
 
-				if ( ! empty( $field['add_meta'] ) ) {
-					$prepared['meta'][ wpinv_clean( $label ) ] = wp_kses_post_deep( $value );
-				}
-				$prepared['all'][ wpinv_clean( $label ) ] = wp_kses_post_deep( $value );
+                if ( ! empty( $field['add_meta'] ) ) {
+                    $prepared['meta'][ wpinv_clean( $label ) ] = wp_kses_post_deep( $value );
+                }
+                $prepared['all'][ wpinv_clean( $label ) ] = wp_kses_post_deep( $value );
 
             }
-		}
+        }
 
-		return $prepared;
+        return $prepared;
 
-	}
+    }
 
-	/**
+    /**
      * Retrieves address details.
      *
-	 * @return array
-	 * @param WPInv_Invoice $invoice
-	 * @param string $type
+     * @return array
+     * @param WPInv_Invoice $invoice
+     * @param string $type
      */
     public function prepare_address_details( $invoice, $type = 'billing' ) {
 
-		$data     = $this->payment_form_submission->get_data();
-		$type     = sanitize_key( $type );
-		$address  = array();
-		$prepared = array();
+        $data     = $this->payment_form_submission->get_data();
+        $type     = sanitize_key( $type );
+        $address  = array();
+        $prepared = array();
 
-		if ( ! empty( $data[ $type ] ) ) {
-			$address = $data[ $type ];
-		}
+        if ( ! empty( $data[ $type ] ) ) {
+            $address = $data[ $type ];
+        }
 
-		// Clean address details.
-		foreach ( $address as $key => $value ) {
-			$key             = sanitize_key( $key );
-			$key             = str_replace( 'wpinv_', '', $key );
-			$value           = wpinv_clean( $value );
-			$prepared[ $key ] = apply_filters( "getpaid_checkout_{$type}_address_$key", $value, $this->payment_form_submission, $invoice );
-		}
+        // Clean address details.
+        foreach ( $address as $key => $value ) {
+            $key             = sanitize_key( $key );
+            $key             = str_replace( 'wpinv_', '', $key );
+            $value           = wpinv_clean( $value );
+            $prepared[ $key ] = apply_filters( "getpaid_checkout_{$type}_address_$key", $value, $this->payment_form_submission, $invoice );
+        }
 
-		// Filter address details.
-		$prepared = apply_filters( "getpaid_checkout_{$type}_address", $prepared, $this->payment_form_submission, $invoice );
+        // Filter address details.
+        $prepared = apply_filters( "getpaid_checkout_{$type}_address", $prepared, $this->payment_form_submission, $invoice );
 
-		// Remove non-whitelisted values.
-		return array_filter( $prepared, 'getpaid_is_address_field_whitelisted', ARRAY_FILTER_USE_KEY );
+        // Remove non-whitelisted values.
+        return array_filter( $prepared, 'getpaid_is_address_field_whitelisted', ARRAY_FILTER_USE_KEY );
 
-	}
+    }
 
-	/**
+    /**
      * Prepares the billing details.
      *
-	 * @return array
-	 * @param WPInv_Invoice $invoice
+     * @return array
+     * @param WPInv_Invoice $invoice
      */
     protected function prepare_billing_info( &$invoice ) {
 
-		$billing_address = $this->prepare_address_details( $invoice, 'billing' );
+        $billing_address = $this->prepare_address_details( $invoice, 'billing' );
 
-		// Update the invoice with the billing details.
-		$invoice->set_props( $billing_address );
+        // Update the invoice with the billing details.
+        $invoice->set_props( $billing_address );
 
-	}
+    }
 
-	/**
+    /**
      * Prepares the shipping details.
      *
-	 * @return array
-	 * @param WPInv_Invoice $invoice
+     * @return array
+     * @param WPInv_Invoice $invoice
      */
     protected function prepare_shipping_info( $invoice ) {
 
-		$data = $this->payment_form_submission->get_data();
+        $data = $this->payment_form_submission->get_data();
 
-		if ( empty( $data['same-shipping-address'] ) ) {
-			return $this->prepare_address_details( $invoice, 'shipping' );
-		}
+        if ( empty( $data['same-shipping-address'] ) ) {
+            return $this->prepare_address_details( $invoice, 'shipping' );
+        }
 
-		return $this->prepare_address_details( $invoice, 'billing' );
+        return $this->prepare_address_details( $invoice, 'billing' );
 
-	}
+    }
 
-	/**
-	 * Confirms the submission is valid and send users to the gateway.
-	 *
-	 * @param WPInv_Invoice $invoice
-	 * @param array $prepared_payment_form_data
-	 * @param array $shipping
-	 */
-	protected function post_process_submission( $invoice, $prepared_payment_form_data, $shipping ) {
+    /**
+     * Confirms the submission is valid and send users to the gateway.
+     *
+     * @param WPInv_Invoice $invoice
+     * @param array $prepared_payment_form_data
+     * @param array $shipping
+     */
+    protected function post_process_submission( $invoice, $prepared_payment_form_data, $shipping ) {
 
-		// Ensure the invoice exists.
+        // Ensure the invoice exists.
         if ( ! $invoice->exists() ) {
             wp_send_json_error( __( 'An error occured while saving your invoice. Please try again.', 'invoicing' ) );
         }
 
-		// Save payment form data.
-		$prepared_payment_form_data = apply_filters( 'getpaid_prepared_payment_form_data', $prepared_payment_form_data, $invoice );
+        // Save payment form data.
+        $prepared_payment_form_data = apply_filters( 'getpaid_prepared_payment_form_data', $prepared_payment_form_data, $invoice );
         delete_post_meta( $invoice->get_id(), 'payment_form_data' );
-		delete_post_meta( $invoice->get_id(), 'additional_meta_data' );
-		if ( ! empty( $prepared_payment_form_data ) ) {
+        delete_post_meta( $invoice->get_id(), 'additional_meta_data' );
+        if ( ! empty( $prepared_payment_form_data ) ) {
 
-			if ( ! empty( $prepared_payment_form_data['all'] ) ) {
-				update_post_meta( $invoice->get_id(), 'payment_form_data', $prepared_payment_form_data['all'] );
-			}
+            if ( ! empty( $prepared_payment_form_data['all'] ) ) {
+                update_post_meta( $invoice->get_id(), 'payment_form_data', $prepared_payment_form_data['all'] );
+            }
 
-			if ( ! empty( $prepared_payment_form_data['meta'] ) ) {
-				update_post_meta( $invoice->get_id(), 'additional_meta_data', $prepared_payment_form_data['meta'] );
-			}
-		}
+            if ( ! empty( $prepared_payment_form_data['meta'] ) ) {
+                update_post_meta( $invoice->get_id(), 'additional_meta_data', $prepared_payment_form_data['meta'] );
+            }
+        }
 
-		// Save payment form data.
-		$shipping = apply_filters( 'getpaid_checkout_shipping_details', $shipping, $this->payment_form_submission );
+        // Save payment form data.
+        $shipping = apply_filters( 'getpaid_checkout_shipping_details', $shipping, $this->payment_form_submission );
         if ( ! empty( $shipping ) ) {
             update_post_meta( $invoice->get_id(), 'shipping_address', $shipping );
-		}
+        }
 
-		// Backwards compatibility.
+        // Backwards compatibility.
         add_filter( 'wp_redirect', array( $this, 'send_redirect_response' ) );
 
-		try {
-			$this->process_payment( $invoice );
-		} catch ( Exception $e ) {
-			wpinv_set_error( 'payment_error', $e->getMessage() );
-		}
+        try {
+            $this->process_payment( $invoice );
+        } catch ( Exception $e ) {
+            wpinv_set_error( 'payment_error', $e->getMessage() );
+        }
 
         // If we are here, there was an error.
-		wpinv_send_back_to_checkout( $invoice );
+        wpinv_send_back_to_checkout( $invoice );
 
-	}
+    }
 
-	/**
-	 * Processes the actual payment.
-	 *
-	 * @param WPInv_Invoice $invoice
-	 */
-	protected function process_payment( $invoice ) {
+    /**
+     * Processes the actual payment.
+     *
+     * @param WPInv_Invoice $invoice
+     */
+    protected function process_payment( $invoice ) {
 
-		// Clear any checkout errors.
-		wpinv_clear_errors();
+        // Clear any checkout errors.
+        wpinv_clear_errors();
 
-		// No need to send free invoices to the gateway.
-		if ( $invoice->is_free() ) {
-			$this->process_free_payment( $invoice );
-		}
+        // No need to send free invoices to the gateway.
+        if ( $invoice->is_free() ) {
+            $this->process_free_payment( $invoice );
+        }
 
-		$submission = $this->payment_form_submission;
+        $submission = $this->payment_form_submission;
 
-		// Fires before sending to the gateway.
-		do_action( 'getpaid_checkout_before_gateway', $invoice, $submission );
+        // Fires before sending to the gateway.
+        do_action( 'getpaid_checkout_before_gateway', $invoice, $submission );
 
-		// Allow the sumission data to be modified before it is sent to the gateway.
-		$submission_data    = $submission->get_data();
-		$submission_gateway = apply_filters( 'getpaid_gateway_submission_gateway', $invoice->get_gateway(), $submission, $invoice );
-		$submission_data    = apply_filters( 'getpaid_gateway_submission_data', $submission_data, $submission, $invoice );
+        // Allow the sumission data to be modified before it is sent to the gateway.
+        $submission_data    = $submission->get_data();
+        $submission_gateway = apply_filters( 'getpaid_gateway_submission_gateway', $invoice->get_gateway(), $submission, $invoice );
+        $submission_data    = apply_filters( 'getpaid_gateway_submission_data', $submission_data, $submission, $invoice );
 
-		// Validate the currency.
-		if ( ! apply_filters( "getpaid_gateway_{$submission_gateway}_is_valid_for_currency", true, $invoice->get_currency() ) ) {
-			wpinv_set_error( 'invalid_currency' );
-		}
+        // Validate the currency.
+        if ( ! apply_filters( "getpaid_gateway_{$submission_gateway}_is_valid_for_currency", true, $invoice->get_currency() ) ) {
+            wpinv_set_error( 'invalid_currency' );
+        }
 
-		// Check to see if we have any errors.
-		if ( wpinv_get_errors() ) {
-			wpinv_send_back_to_checkout( $invoice );
-		}
+        // Check to see if we have any errors.
+        if ( wpinv_get_errors() ) {
+            wpinv_send_back_to_checkout( $invoice );
+        }
 
-		// Send info to the gateway for payment processing
-		do_action( "getpaid_gateway_$submission_gateway", $invoice, $submission_data, $submission );
+        // Send info to the gateway for payment processing
+        do_action( "getpaid_gateway_$submission_gateway", $invoice, $submission_data, $submission );
 
-		// Backwards compatibility.
-		wpinv_send_to_gateway( $submission_gateway, $invoice );
+        // Backwards compatibility.
+        wpinv_send_to_gateway( $submission_gateway, $invoice );
 
-	}
+    }
 
-	/**
-	 * Marks the invoice as paid in case the checkout is free.
-	 *
-	 * @param WPInv_Invoice $invoice
-	 */
-	protected function process_free_payment( $invoice ) {
+    /**
+     * Marks the invoice as paid in case the checkout is free.
+     *
+     * @param WPInv_Invoice $invoice
+     */
+    protected function process_free_payment( $invoice ) {
 
-		$invoice->set_gateway( 'none' );
-		$invoice->add_note( __( "This is a free invoice and won't be sent to the payment gateway", 'invoicing' ), false, false, true );
-		$invoice->mark_paid();
-		wpinv_send_to_success_page( array( 'invoice_key' => $invoice->get_key() ) );
+        $invoice->set_gateway( 'none' );
+        $invoice->add_note( __( "This is a free invoice and won't be sent to the payment gateway", 'invoicing' ), false, false, true );
+        $invoice->mark_paid();
+        wpinv_send_to_success_page( array( 'invoice_key' => $invoice->get_key() ) );
 
-	}
+    }
 
-	/**
+    /**
      * Sends a redrect response to payment details.
      *
      */