AyeCode / invoicing

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

Indentation +573 added lines, -573 removed lines

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

Spacing +91 added lines, -91 removed lines

@@ -7,7 +7,7 @@ 
  * @since   2.0.0
  */
 
-defined( 'ABSPATH' ) || exit;
+defined('ABSPATH') || exit;
 
 /**
  * GetPaid REST date based controller class.
@@ -43,15 +43,15 @@ 
 	 * @param WP_REST_Request $request Request object.
 	 * @return array The appropriate date range.
 	 */
-	public function get_date_range( $request ) {
+	public function get_date_range($request) {
 
 		// If not supported, assume all time.
-		if ( ! in_array( $request['period'], array( 'custom', 'today', 'yesterday', 'week', 'last_week', '7_days', '30_days', '60_days', '90_days', '180_days', 'month', 'last_month', 'quarter', 'last_quarter', 'year', 'last_year' ) ) ) {
+		if (!in_array($request['period'], array('custom', 'today', 'yesterday', 'week', 'last_week', '7_days', '30_days', '60_days', '90_days', '180_days', 'month', 'last_month', 'quarter', 'last_quarter', 'year', 'last_year'))) {
 			$request['period'] = '7_days';
 		}
 
-		$date_range = call_user_func( array( $this, 'get_' . $request['period'] . '_date_range' ), $request );
-		$this->prepare_interval( $date_range );
+		$date_range = call_user_func(array($this, 'get_' . $request['period'] . '_date_range'), $request);
+		$this->prepare_interval($date_range);
 
 		return $date_range;
 
@@ -63,25 +63,25 @@ 
 	 * @param array $range Date range.
 	 * @return array The appropriate date range.
 	 */
-	public function prepare_interval( $range ) {
+	public function prepare_interval($range) {
 
-		$before = strtotime( $range['before'] ) - DAY_IN_SECONDS;
-		$after  = strtotime( $range['after'] ) + DAY_IN_SECONDS;
-		if ( 'day' === $this->groupby ) {
-			$difference     = max( DAY_IN_SECONDS, ( DAY_IN_SECONDS + $before - $after ) ); // Prevent division by 0;
-			$this->interval = absint( ceil( max( 1, $difference / DAY_IN_SECONDS ) ) );
+		$before = strtotime($range['before']) - DAY_IN_SECONDS;
+		$after  = strtotime($range['after']) + DAY_IN_SECONDS;
+		if ('day' === $this->groupby) {
+			$difference     = max(DAY_IN_SECONDS, (DAY_IN_SECONDS + $before - $after)); // Prevent division by 0;
+			$this->interval = absint(ceil(max(1, $difference / DAY_IN_SECONDS)));
 			return;
 		}
 
 		$this->interval = 0;
-		$min_date       = strtotime( date( 'Y-m-01', $after ) );
+		$min_date       = strtotime(date('Y-m-01', $after));
 
-		while ( $min_date <= $before ) {
-			$this->interval ++;
-			$min_date = strtotime( '+1 MONTH', $min_date );
+		while ($min_date <= $before) {
+			$this->interval++;
+			$min_date = strtotime('+1 MONTH', $min_date);
 		}
 
-		$this->interval = max( 1, $this->interval );
+		$this->interval = max(1, $this->interval);
 
 	}
 
@@ -91,17 +91,17 @@ 
 	 * @param WP_REST_Request $request Request object.
 	 * @return array The appropriate date range.
 	 */
-	public function get_custom_date_range( $request ) {
+	public function get_custom_date_range($request) {
 
-		$after  = max( strtotime( '-20 years' ), strtotime( sanitize_text_field( $request['after'] ) ) );
-		$before = strtotime( '+1 day', current_time( 'timestamp' ) );
+		$after  = max(strtotime('-20 years'), strtotime(sanitize_text_field($request['after'])));
+		$before = strtotime('+1 day', current_time('timestamp'));
 
-		if ( ! empty( $request['before'] ) ) {
-			$before  = min( $before, strtotime( sanitize_text_field( $request['before'] ) ) );
+		if (!empty($request['before'])) {
+			$before = min($before, strtotime(sanitize_text_field($request['before'])));
 		}
 
 		// 3 months max for day view
-		if ( floor( ( $before - $after ) / MONTH_IN_SECONDS ) > 3 ) {
+		if (floor(($before - $after) / MONTH_IN_SECONDS) > 3) {
 			$this->groupby = 'month';
 		}
 
@@ -109,14 +109,14 @@ 
 		$difference           = $before - $after;
 		$this->previous_range = array(
 			'period' => 'custom',
-			'before' => date( 'Y-m-d', $before - $difference ),
-			'after'  => date( 'Y-m-d', $after - $difference ),
+			'before' => date('Y-m-d', $before - $difference),
+			'after'  => date('Y-m-d', $after - $difference),
 		);
 
 		// Generate the report.
 		return array(
-			'before' => date( 'Y-m-d', $before ),
-			'after' => date( 'Y-m-d', $after ),
+			'before' => date('Y-m-d', $before),
+			'after' => date('Y-m-d', $after),
 		);
 
 	}
@@ -135,8 +135,8 @@ 
 
 		// Generate the report.
 		return array(
-			'before' => date( 'Y-m-d', strtotime( '+1 day', current_time( 'timestamp' ) ) ),
-			'after'  => date( 'Y-m-d', strtotime( '-1 day', current_time( 'timestamp' ) ) ),
+			'before' => date('Y-m-d', strtotime('+1 day', current_time('timestamp'))),
+			'after'  => date('Y-m-d', strtotime('-1 day', current_time('timestamp'))),
 		);
 
 	}
@@ -151,14 +151,14 @@ 
 		// Set the previous date range.
 		$this->previous_range = array(
 			'period' => 'custom',
-			'before' => date( 'Y-m-d', strtotime( '-1 day', current_time( 'timestamp' ) ) ),
-			'after'  => date( 'Y-m-d', strtotime( '-3 days', current_time( 'timestamp' ) ) ),
+			'before' => date('Y-m-d', strtotime('-1 day', current_time('timestamp'))),
+			'after'  => date('Y-m-d', strtotime('-3 days', current_time('timestamp'))),
 		);
 
 		// Generate the report.
 		return array(
-			'before' => date( 'Y-m-d', current_time( 'timestamp' ) ),
-			'after'  => date( 'Y-m-d', strtotime( '-2 days', current_time( 'timestamp' ) ) ),
+			'before' => date('Y-m-d', current_time('timestamp')),
+			'after'  => date('Y-m-d', strtotime('-2 days', current_time('timestamp'))),
 		);
 
 	}
@@ -177,8 +177,8 @@ 
 
 		// Generate the report.
 		return array(
-			'before' => date( 'Y-m-d', strtotime( 'sunday last week', current_time( 'timestamp' )  ) + 8 * DAY_IN_SECONDS ),
-			'after'  => date( 'Y-m-d', strtotime( 'sunday last week', current_time( 'timestamp' )  ) ),
+			'before' => date('Y-m-d', strtotime('sunday last week', current_time('timestamp')) + 8 * DAY_IN_SECONDS),
+			'after'  => date('Y-m-d', strtotime('sunday last week', current_time('timestamp'))),
 		);
 
 	}
@@ -193,14 +193,14 @@ 
 		// Set the previous date range.
 		$this->previous_range = array(
 			'period' => 'custom',
-			'before' => date( 'Y-m-d', strtotime( 'monday last week', current_time( 'timestamp' )  ) ),
-			'after'  => date( 'Y-m-d', strtotime( 'monday last week', current_time( 'timestamp' )  ) - 8 * DAY_IN_SECONDS ),
+			'before' => date('Y-m-d', strtotime('monday last week', current_time('timestamp'))),
+			'after'  => date('Y-m-d', strtotime('monday last week', current_time('timestamp')) - 8 * DAY_IN_SECONDS),
 		);
 
 		// Generate the report.
 		return array(
-			'before' => date( 'Y-m-d', strtotime( 'monday this week', current_time( 'timestamp' )  ) ),
-			'after'  => date( 'Y-m-d', strtotime( 'monday last week', current_time( 'timestamp' )  ) - DAY_IN_SECONDS ),
+			'before' => date('Y-m-d', strtotime('monday this week', current_time('timestamp'))),
+			'after'  => date('Y-m-d', strtotime('monday last week', current_time('timestamp')) - DAY_IN_SECONDS),
 		);
 
 	}
@@ -215,14 +215,14 @@ 
 		// Set the previous date range.
 		$this->previous_range = array(
 			'period' => 'custom',
-			'before' => date( 'Y-m-d', strtotime( '-7 days', current_time( 'timestamp' ) ) ),
-			'after'  => date( 'Y-m-d', strtotime( '-15 days', current_time( 'timestamp' ) ) ),
+			'before' => date('Y-m-d', strtotime('-7 days', current_time('timestamp'))),
+			'after'  => date('Y-m-d', strtotime('-15 days', current_time('timestamp'))),
 		);
 
 		// Generate the report.
 		return array(
-			'before' => date( 'Y-m-d', current_time( 'timestamp' ) ),
-			'after'  => date( 'Y-m-d', strtotime( '-8 days', current_time( 'timestamp' ) ) ),
+			'before' => date('Y-m-d', current_time('timestamp')),
+			'after'  => date('Y-m-d', strtotime('-8 days', current_time('timestamp'))),
 		);
 
 	}
@@ -237,14 +237,14 @@ 
 		// Set the previous date range.
 		$this->previous_range = array(
 			'period' => 'custom',
-			'before' => date( 'Y-m-d', strtotime( '-30 days', current_time( 'timestamp' ) ) ),
-			'after'  => date( 'Y-m-d', strtotime( '-61 days', current_time( 'timestamp' ) ) ),
+			'before' => date('Y-m-d', strtotime('-30 days', current_time('timestamp'))),
+			'after'  => date('Y-m-d', strtotime('-61 days', current_time('timestamp'))),
 		);
 
 		// Generate the report.
 		return array(
-			'before' => date( 'Y-m-d', current_time( 'timestamp' ) ),
-			'after'  => date( 'Y-m-d', strtotime( '-31 days', current_time( 'timestamp' ) ) ),
+			'before' => date('Y-m-d', current_time('timestamp')),
+			'after'  => date('Y-m-d', strtotime('-31 days', current_time('timestamp'))),
 		);
 
 	}
@@ -261,14 +261,14 @@ 
 		// Set the previous date range.
 		$this->previous_range = array(
 			'period' => 'custom',
-			'before' => date( 'Y-m-d', strtotime( '-90 days', current_time( 'timestamp' ) ) ),
-			'after'  => date( 'Y-m-d', strtotime( '-181 days', current_time( 'timestamp' ) ) ),
+			'before' => date('Y-m-d', strtotime('-90 days', current_time('timestamp'))),
+			'after'  => date('Y-m-d', strtotime('-181 days', current_time('timestamp'))),
 		);
 
 		// Generate the report.
 		return array(
-			'before' => date( 'Y-m-d', current_time( 'timestamp' ) ),
-			'after'  => date( 'Y-m-d', strtotime( '-91 days', current_time( 'timestamp' ) ) ),
+			'before' => date('Y-m-d', current_time('timestamp')),
+			'after'  => date('Y-m-d', strtotime('-91 days', current_time('timestamp'))),
 		);
 
 	}
@@ -285,14 +285,14 @@ 
 		// Set the previous date range.
 		$this->previous_range = array(
 			'period' => 'custom',
-			'before' => date( 'Y-m-d', strtotime( '-180 days', current_time( 'timestamp' ) ) ),
-			'after'  => date( 'Y-m-d', strtotime( '-361 days', current_time( 'timestamp' ) ) ),
+			'before' => date('Y-m-d', strtotime('-180 days', current_time('timestamp'))),
+			'after'  => date('Y-m-d', strtotime('-361 days', current_time('timestamp'))),
 		);
 
 		// Generate the report.
 		return array(
-			'before' => date( 'Y-m-d', current_time( 'timestamp' ) ),
-			'after'  => date( 'Y-m-d', strtotime( '-181 days', current_time( 'timestamp' ) ) ),
+			'before' => date('Y-m-d', current_time('timestamp')),
+			'after'  => date('Y-m-d', strtotime('-181 days', current_time('timestamp'))),
 		);
 
 	}
@@ -307,14 +307,14 @@ 
 		// Set the previous date range.
 		$this->previous_range = array(
 			'period' => 'custom',
-			'before' => date( 'Y-m-d', strtotime( '-60 days', current_time( 'timestamp' ) ) ),
-			'after'  => date( 'Y-m-d', strtotime( '-121 days', current_time( 'timestamp' ) ) ),
+			'before' => date('Y-m-d', strtotime('-60 days', current_time('timestamp'))),
+			'after'  => date('Y-m-d', strtotime('-121 days', current_time('timestamp'))),
 		);
 
 		// Generate the report.
 		return array(
-			'before' => date( 'Y-m-d', current_time( 'timestamp' ) ),
-			'after'  => date( 'Y-m-d', strtotime( '-61 days', current_time( 'timestamp' ) ) ),
+			'before' => date('Y-m-d', current_time('timestamp')),
+			'after'  => date('Y-m-d', strtotime('-61 days', current_time('timestamp'))),
 		);
 
 	}
@@ -333,8 +333,8 @@ 
 
 		// Generate the report.
 		return array(
-			'before' => date( 'Y-m-01', strtotime( 'next month', current_time( 'timestamp' ) ) ),
-			'after'  => date( 'Y-m-t', strtotime( 'last month', current_time( 'timestamp' ) ) ),
+			'before' => date('Y-m-01', strtotime('next month', current_time('timestamp'))),
+			'after'  => date('Y-m-t', strtotime('last month', current_time('timestamp'))),
 		);
 
 	}
@@ -349,14 +349,14 @@ 
 		// Set the previous date range.
 		$this->previous_range = array(
 			'period' => 'custom',
-			'before' => date( 'Y-m-1', strtotime( 'last month', current_time( 'timestamp' ) ) ),
-			'after'  => date( 'Y-m-t', strtotime( "-3 months", current_time( 'timestamp' ) ) ),
+			'before' => date('Y-m-1', strtotime('last month', current_time('timestamp'))),
+			'after'  => date('Y-m-t', strtotime("-3 months", current_time('timestamp'))),
 		);
 
 		// Generate the report.
 		return array(
-			'before' => date( 'Y-m-1', current_time( 'timestamp' ) ),
-			'after'  => date( 'Y-m-t', strtotime( "-2 months", current_time( 'timestamp' ) ) ),
+			'before' => date('Y-m-1', current_time('timestamp')),
+			'after'  => date('Y-m-t', strtotime("-2 months", current_time('timestamp'))),
 		);
 
 	}
@@ -414,9 +414,9 @@ 
 	 */
 	public function get_quarter() {
 
-		$month    = (int) date( 'n', current_time( 'timestamp' ) );
-		$quarters = array( 1, 1, 1, 2, 2, 2, 3, 3, 3, 4, 4, 4 );
-		return $quarters[ $month - 1 ];
+		$month    = (int) date('n', current_time('timestamp'));
+		$quarters = array(1, 1, 1, 2, 2, 2, 3, 3, 3, 4, 4, 4);
+		return $quarters[$month - 1];
 
 	}
 
@@ -434,7 +434,7 @@ 
 
 		// Generate the report.
 		$quarters = $this->get_quarters();
-		return $quarters[ $this->get_quarter() + 1 ];
+		return $quarters[$this->get_quarter() + 1];
 
 	}
 
@@ -450,12 +450,12 @@ 
 
 		// Set the previous date range.
 		$this->previous_range = array_merge(
-			$quarters[ $quarter - 1 ],
-			array( 'period' => 'custom' )
+			$quarters[$quarter - 1],
+			array('period' => 'custom')
 		);
 
 		// Generate the report.
-		return $quarters[ $quarter ];
+		return $quarters[$quarter];
 
 	}
 
@@ -475,8 +475,8 @@ 
 
 		// Generate the report.
 		return array(
-			'before' => date( 'Y-m-d', strtotime( 'next year January 1st', current_time( 'timestamp' ) ) ),
-			'after'  => date( 'Y-m-d', strtotime( 'last year December 31st', current_time( 'timestamp' ) ) ),
+			'before' => date('Y-m-d', strtotime('next year January 1st', current_time('timestamp'))),
+			'after'  => date('Y-m-d', strtotime('last year December 31st', current_time('timestamp'))),
 		);
 
 	}
@@ -494,15 +494,15 @@ 
 		$year          = (int) date('Y') - 3;
 		$this->previous_range = array(
 			'period' => 'custom',
-			'before' => date( 'Y-m-d', strtotime( 'first day of january last year', current_time( 'timestamp' ) ) ),
+			'before' => date('Y-m-d', strtotime('first day of january last year', current_time('timestamp'))),
 			'after'  => "$year-12-31",
 		);
 
 		// Generate the report.
-		$year          = (int) date('Y') - 2;
+		$year = (int) date('Y') - 2;
 		return array(
 			'after'  => "$year-12-31",
-			'before' => date( 'Y-m-d', strtotime( 'first day of january this year', current_time( 'timestamp' ) ) ),
+			'before' => date('Y-m-d', strtotime('first day of january this year', current_time('timestamp'))),
 		);
 
 	}
@@ -514,21 +514,21 @@ 
 	 * @param string $date_field The date field.
 	 * @return string The appropriate SQL.
 	 */
-	public function get_date_range_sql( $request, $date_field ) {
+	public function get_date_range_sql($request, $date_field) {
 		global $wpdb;
 
 		$sql = '1=1';
-		$range = $this->get_date_range( $request );
+		$range = $this->get_date_range($request);
 
-		if ( ! empty( $range['after'] ) ) {
-			$sql .= ' AND ' .  $wpdb->prepare(
+		if (!empty($range['after'])) {
+			$sql .= ' AND ' . $wpdb->prepare(
 				"$date_field > %s",
 				$range['after']
 			);
 		}
 
-		if ( ! empty( $range['before'] ) ) {
-			$sql .= ' AND ' .  $wpdb->prepare(
+		if (!empty($range['before'])) {
+			$sql .= ' AND ' . $wpdb->prepare(
 				"$date_field < %s",
 				$range['before']
 			);
@@ -544,9 +544,9 @@ 
 	 * @param string $date_field The date field.
 	 * @return string The appropriate SQL.
 	 */
-	public function get_group_by_sql( $date_field ) {
+	public function get_group_by_sql($date_field) {
 
-		if ( 'day' === $this->groupby ) {
+		if ('day' === $this->groupby) {
 			return "YEAR($date_field), MONTH($date_field), DAY($date_field)";
 		}
 
@@ -560,32 +560,32 @@ 
 	 */
 	public function get_collection_params() {
 		return array(
-			'context' => $this->get_context_param( array( 'default' => 'view' ) ),
+			'context' => $this->get_context_param(array('default' => 'view')),
 			'period' => array(
-				'description'       => __( 'Limit to results of a specific period.', 'invoicing' ),
+				'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' ),
+				'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' ),
+				'description'       => sprintf(__('Limit to results after a specific date, the date needs to be in the %s format.', 'invoicing'), 'YYYY-MM-DD'),
 				'type'              => 'string',
 				'format'            => 'date',
 				'validate_callback' => 'rest_validate_request_arg',
 				'sanitize_callback' => 'sanitize_text_field',
-				'default'           => date( 'Y-m-d', strtotime( '-8 days', current_time( 'timestamp' ) ) ),
+				'default'           => date('Y-m-d', strtotime('-8 days', current_time('timestamp'))),
 			),
 			'before' => array(
 				/* translators: %s: date format */
-				'description'       => sprintf( __( 'Limit to results before a specific date, the date needs to be in the %s format.', 'invoicing' ), 'YYYY-MM-DD' ),
+				'description'       => sprintf(__('Limit to results before a specific date, the date needs to be in the %s format.', 'invoicing'), 'YYYY-MM-DD'),
 				'type'              => 'string',
 				'format'            => 'date',
 				'validate_callback' => 'rest_validate_request_arg',
 				'sanitize_callback' => 'sanitize_text_field',
-				'default'           => date( 'Y-m-d', current_time( 'timestamp' ) ),
+				'default'           => date('Y-m-d', current_time('timestamp')),
 			),
 		);
 	}

templates/payment-forms/variations/select.php

Spacing +7 added lines, -7 removed lines

@@ -7,17 +7,17 @@ 
  * @version 1.0.19
  */
 
-defined( 'ABSPATH' ) || exit;
+defined('ABSPATH') || exit;
 
 // Prepare the selectable items.
 $selectable = array();
-foreach ( $form->get_items() as $item ) {
-    if ( ! $item->is_required ) {
-        $selectable[$item->get_id()] = strip_tags( $item->get_name() . ' — ' . wpinv_price( $item->get_initial_price() ) );
+foreach ($form->get_items() as $item) {
+    if (!$item->is_required) {
+        $selectable[$item->get_id()] = strip_tags($item->get_name() . ' — ' . wpinv_price($item->get_initial_price()));
     }
 }
 
-if ( empty( $selectable ) ) {
+if (empty($selectable)) {
     return;
 }
 
@@ -27,9 +27,9 @@ 
 echo aui()->select(
     array(
         'name'       => 'getpaid-payment-form-selected-item',
-        'id'         => 'getpaid-payment-form-selected-item' . uniqid( '_' ),
+        'id'         => 'getpaid-payment-form-selected-item' . uniqid('_'),
         'required'   => true,
-        'label'      => __( 'Select Item', 'invoicing' ),
+        'label'      => __('Select Item', 'invoicing'),
         'label_type' => 'vertical',
         'inline'     => false,
         'options'    => $selectable,

templates/invoice/header-right-actions.php

Spacing +14 added lines, -14 removed lines

@@ -8,7 +8,7 @@ 
  * @var WPInv_Invoice $invoice
  */
 
-defined( 'ABSPATH' ) || exit;
+defined('ABSPATH') || exit;
 
 ?>
 
@@ -21,43 +21,43 @@ 
             $actions[] = sprintf(
                 '<a href="javascript:void(0)" class="btn btn-sm m-1 d-inline-block btn-secondary invoice-action-print d-none d-lg-inline-block" onclick="window.print();">%s</a>',
                 sprintf(
-                    __( 'Print %s', 'invoicing' ),
-                    ucfirst( $invoice->get_invoice_quote_type() )
+                    __('Print %s', 'invoicing'),
+                    ucfirst($invoice->get_invoice_quote_type())
                 )
             );
 
-            if ( is_user_logged_in() ) {
+            if (is_user_logged_in()) {
 
                 $actions[] = sprintf(
                     '<a href="%s" class="btn btn-sm btn-secondary m-1 d-inline-block invoice-action-history">%s</a>',
-                    esc_url( wpinv_get_history_page_uri( $invoice->get_post_type() ) ),
+                    esc_url(wpinv_get_history_page_uri($invoice->get_post_type())),
                     sprintf(
-                        __( '%s History', 'invoicing' ),
-                        ucfirst( $invoice->get_invoice_quote_type() )
+                        __('%s History', 'invoicing'),
+                        ucfirst($invoice->get_invoice_quote_type())
                     )
                 );
 
             }
 
-            if ( wpinv_current_user_can_manage_invoicing() ) {
+            if (wpinv_current_user_can_manage_invoicing()) {
 
                 $actions[] = sprintf(
                     '<a href="%s" class="btn btn-sm btn-secondary m-1 d-inline-block invoice-action-edit">%s</a>',
-                    esc_url( get_edit_post_link( $invoice->get_id() ) ),
+                    esc_url(get_edit_post_link($invoice->get_id())),
                     sprintf(
-                        __( 'Edit %s', 'invoicing' ),
-                        ucfirst( $invoice->get_invoice_quote_type() )
+                        __('Edit %s', 'invoicing'),
+                        ucfirst($invoice->get_invoice_quote_type())
                     )
                 );
 
             }
 
-            $actions = apply_filters( 'getpaid_invoice_header_right_actions_array', $actions, $invoice );
-            echo implode( '', $actions );
+            $actions = apply_filters('getpaid_invoice_header_right_actions_array', $actions, $invoice);
+            echo implode('', $actions);
 
         ?>
 
-        <?php do_action('wpinv_invoice_display_right_actions', $invoice ); ?>
+        <?php do_action('wpinv_invoice_display_right_actions', $invoice); ?>
     </div>
 
 <?php

templates/invoice/invoice-type.php

Spacing +2 added lines, -2 removed lines

@@ -7,11 +7,11 @@
  * @version 1.0.19
  */
 
-defined( 'ABSPATH' ) || exit;
+defined('ABSPATH') || exit;
 
 ?>
 <h2 class="h3 text-dark">
-    <?php echo apply_filters( 'getpaid_invoice_type_label', ucfirst( $invoice->get_invoice_quote_type() ), $invoice ); ?>
+    <?php echo apply_filters('getpaid_invoice_type_label', ucfirst($invoice->get_invoice_quote_type()), $invoice); ?>
 </h2>
 
 <?php

templates/emails/wpinv-email-footer.php

Spacing +3 added lines, -3 removed lines

@@ -1,10 +1,10 @@
 <?php
 // don't load directly
-if ( !defined('ABSPATH') )
+if (!defined('ABSPATH'))
     die('-1');
 
-$email_footer = apply_filters( 'wpinv_email_footer_text', wpinv_get_option( 'email_footer_text', get_bloginfo( 'name', 'display' ) . ' - ' . __( 'Powered by GetPaid', 'invoicing' ) ) );
-$email_footer = $email_footer ? wpautop( wp_kses_post( wptexturize( $email_footer ) ) ) : '';
+$email_footer = apply_filters('wpinv_email_footer_text', wpinv_get_option('email_footer_text', get_bloginfo('name', 'display') . ' - ' . __('Powered by GetPaid', 'invoicing')));
+$email_footer = $email_footer ? wpautop(wp_kses_post(wptexturize($email_footer))) : '';
 ?>
                                                             </div>
                                                         </td>

Braces +2 added lines, -1 removed lines

@@ -1,7 +1,8 @@
 <?php
 // don't load directly
-if ( !defined('ABSPATH') )
+if ( !defined('ABSPATH') ) {
     die('-1');
+}
 
 $email_footer = apply_filters( 'wpinv_email_footer_text', wpinv_get_option( 'email_footer_text', get_bloginfo( 'name', 'display' ) . ' - ' . __( 'Powered by GetPaid', 'invoicing' ) ) );
 $email_footer = $email_footer ? wpautop( wp_kses_post( wptexturize( $email_footer ) ) ) : '';

templates/payment-forms/elements/billing_email.php

Spacing +13 added lines, -13 removed lines

@@ -7,35 +7,35 @@ 
  * @version 1.0.19
  */
 
-defined( 'ABSPATH' ) || exit;
+defined('ABSPATH') || exit;
 
 $value = '';
 $class = '';
 
-if ( ! empty( $form->invoice ) ) {
-    $value   = sanitize_email( $form->invoice->get_email() );
-} else if ( is_user_logged_in() ) {
+if (!empty($form->invoice)) {
+    $value = sanitize_email($form->invoice->get_email());
+} else if (is_user_logged_in()) {
     $user  = wp_get_current_user();
-    $value = sanitize_email( $user->user_email );
+    $value = sanitize_email($user->user_email);
 }
 
-if ( ! empty( $value ) && ! empty( $hide_billing_email ) ) {
+if (!empty($value) && !empty($hide_billing_email)) {
     $class = 'd-none';
 }
 
-do_action( 'getpaid_before_payment_form_billing_email', $form );
+do_action('getpaid_before_payment_form_billing_email', $form);
 
 echo "<span class='$class'>";
 
 echo aui()->input(
     array(
         'name'       => 'billing_email',
-        'id'         => esc_attr( $id ) . uniqid( '_' ),
-        'placeholder'=> empty( $placeholder ) ? '' : esc_attr( $placeholder ),
-        'required'   => ! empty( $required ),
-        'label'      => empty( $label ) ? '' : wp_kses_post( $label ) . '<span class="text-danger"> *</span>',
+        'id'         => esc_attr($id) . uniqid('_'),
+        'placeholder'=> empty($placeholder) ? '' : esc_attr($placeholder),
+        'required'   => !empty($required),
+        'label'      => empty($label) ? '' : wp_kses_post($label) . '<span class="text-danger"> *</span>',
         'label_type' => 'vertical',
-        'help_text'  => empty( $description ) ? '' : wp_kses_post( $description ),
+        'help_text'  => empty($description) ? '' : wp_kses_post($description),
         'type'       => 'email',
         'value'      => $value,
         'class'      => 'wpinv_billing_email',
@@ -47,4 +47,4 @@ 
 
 echo '</span>';
 
-do_action( 'getpaid_after_payment_form_billing_email', $form );
+do_action('getpaid_after_payment_form_billing_email', $form);

includes/data/vat-number-regexes.php

Spacing +1 added lines, -1 removed lines

@@ -6,7 +6,7 @@
  * @package Invoicing/data
  */
 
-defined( 'ABSPATH' ) || exit;
+defined('ABSPATH') || exit;
 
 return array(
 

includes/geolocation/class-getpaid-geolocation.php

Indentation +259 added lines, -259 removed lines

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

Spacing +49 added lines, -49 removed lines

@@ -6,7 +6,7 @@ 
  *
  */
 
-defined( 'ABSPATH' ) || exit;
+defined('ABSPATH') || exit;
 
 /**
  * GetPaid_Geolocation Class.
@@ -64,31 +64,31 @@ 
 
 		$transient_name = 'external_ip_address_0.0.0.0';
 
-		if ( '' !== self::get_ip_address() ) {
-			$transient_name      = 'external_ip_address_' . self::get_ip_address();
+		if ('' !== self::get_ip_address()) {
+			$transient_name = 'external_ip_address_' . self::get_ip_address();
 		}
 
 		// Try retrieving from cache.
-		$external_ip_address = get_transient( $transient_name );
+		$external_ip_address = get_transient($transient_name);
 
-		if ( false === $external_ip_address ) {
+		if (false === $external_ip_address) {
 			$external_ip_address     = '0.0.0.0';
-			$ip_lookup_services      = apply_filters( 'getpaid_geolocation_ip_lookup_apis', self::$ip_lookup_apis );
-			$ip_lookup_services_keys = array_keys( $ip_lookup_services );
-			shuffle( $ip_lookup_services_keys );
+			$ip_lookup_services      = apply_filters('getpaid_geolocation_ip_lookup_apis', self::$ip_lookup_apis);
+			$ip_lookup_services_keys = array_keys($ip_lookup_services);
+			shuffle($ip_lookup_services_keys);
 
-			foreach ( $ip_lookup_services_keys as $service_name ) {
-				$service_endpoint = $ip_lookup_services[ $service_name ];
-				$response         = wp_safe_remote_get( $service_endpoint, array( 'timeout' => 2 ) );
+			foreach ($ip_lookup_services_keys as $service_name) {
+				$service_endpoint = $ip_lookup_services[$service_name];
+				$response         = wp_safe_remote_get($service_endpoint, array('timeout' => 2));
 
-				if ( ! is_wp_error( $response ) && rest_is_ip_address( $response['body'] ) ) {
-					$external_ip_address = apply_filters( 'getpaid_geolocation_ip_lookup_api_response', wpinv_clean( $response['body'] ), $service_name );
+				if (!is_wp_error($response) && rest_is_ip_address($response['body'])) {
+					$external_ip_address = apply_filters('getpaid_geolocation_ip_lookup_api_response', wpinv_clean($response['body']), $service_name);
 					break;
 				}
 
 			}
 
-			set_transient( $transient_name, $external_ip_address, WEEK_IN_SECONDS );
+			set_transient($transient_name, $external_ip_address, WEEK_IN_SECONDS);
 		}
 
 		return $external_ip_address;
@@ -102,9 +102,9 @@ 
 	 * @param  bool   $api_fallback If true, uses geolocation APIs if the database file doesn't exist (can be slower).
 	 * @return array
 	 */
-	public static function geolocate_ip( $ip_address = '', $fallback = false, $api_fallback = true ) {
+	public static function geolocate_ip($ip_address = '', $fallback = false, $api_fallback = true) {
 
-		if ( empty( $ip_address ) ) {
+		if (empty($ip_address)) {
 			$ip_address = self::get_ip_address();
 		}
 
@@ -112,9 +112,9 @@ 
 		self::$current_user_ip = $ip_address;
 
 		// Filter to allow custom geolocation of the IP address.
-		$country_code = apply_filters( 'getpaid_geolocate_ip', false, $ip_address, $fallback, $api_fallback );
+		$country_code = apply_filters('getpaid_geolocate_ip', false, $ip_address, $fallback, $api_fallback);
 
-		if ( false !== $country_code ) {
+		if (false !== $country_code) {
 
 			return array(
 				'country'  => $country_code,
@@ -134,7 +134,7 @@ 
 		 * @param array  $geolocation Geolocation data, including country, state, city, and postcode.
 		 * @param string $ip_address  IP Address.
 		 */
-		$geolocation  = apply_filters(
+		$geolocation = apply_filters(
 			'getpaid_get_geolocation',
 			array(
 				'country'  => $country_code,
@@ -146,18 +146,18 @@ 
 		);
 
 		// If we still haven't found a country code, let's consider doing an API lookup.
-		if ( '' === $geolocation['country'] && $api_fallback ) {
-			$geolocation['country'] = self::geolocate_via_api( $ip_address );
+		if ('' === $geolocation['country'] && $api_fallback) {
+			$geolocation['country'] = self::geolocate_via_api($ip_address);
 		}
 
 		// It's possible that we're in a local environment, in which case the geolocation needs to be done from the
 		// external address.
-		if ( '' === $geolocation['country'] && $fallback ) {
+		if ('' === $geolocation['country'] && $fallback) {
 			$external_ip_address = self::get_external_ip_address();
 
 			// Only bother with this if the external IP differs.
-			if ( '0.0.0.0' !== $external_ip_address && $external_ip_address !== $ip_address ) {
-				return self::geolocate_ip( $external_ip_address, false, $api_fallback );
+			if ('0.0.0.0' !== $external_ip_address && $external_ip_address !== $ip_address) {
+				return self::geolocate_ip($external_ip_address, false, $api_fallback);
 			}
 
 		}
@@ -187,12 +187,12 @@ 
 			'HTTP_X_COUNTRY_CODE',
 		);
 
-		foreach ( $headers as $header ) {
-			if ( empty( $_SERVER[ $header ] ) ) {
+		foreach ($headers as $header) {
+			if (empty($_SERVER[$header])) {
 				continue;
 			}
 
-			$country_code = strtoupper( sanitize_text_field( wp_unslash( $_SERVER[ $header ] ) ) );
+			$country_code = strtoupper(sanitize_text_field(wp_unslash($_SERVER[$header])));
 			break;
 		}
 
@@ -211,36 +211,36 @@ 
 	 * @param  string $ip_address IP address.
 	 * @return string
 	 */
-	protected static function geolocate_via_api( $ip_address ) {
+	protected static function geolocate_via_api($ip_address) {
 
 		// Retrieve from cache...
-		$country_code = get_transient( 'geoip_' . $ip_address );
+		$country_code = get_transient('geoip_' . $ip_address);
 
 		// If missing, retrieve from the API.
-		if ( false === $country_code ) {
-			$geoip_services = apply_filters( 'getpaid_geolocation_geoip_apis', self::$geoip_apis );
+		if (false === $country_code) {
+			$geoip_services = apply_filters('getpaid_geolocation_geoip_apis', self::$geoip_apis);
 
-			if ( empty( $geoip_services ) ) {
+			if (empty($geoip_services)) {
 				return '';
 			}
 
-			$geoip_services_keys = array_keys( $geoip_services );
+			$geoip_services_keys = array_keys($geoip_services);
 
-			shuffle( $geoip_services_keys );
+			shuffle($geoip_services_keys);
 
-			foreach ( $geoip_services_keys as $service_name ) {
+			foreach ($geoip_services_keys as $service_name) {
 
-				$service_endpoint = $geoip_services[ $service_name ];
-				$response         = wp_safe_remote_get( sprintf( $service_endpoint, $ip_address ), array( 'timeout' => 2 ) );
-				$country_code     = sanitize_text_field( strtoupper( self::handle_geolocation_response( $response, $service_name ) ) );
+				$service_endpoint = $geoip_services[$service_name];
+				$response         = wp_safe_remote_get(sprintf($service_endpoint, $ip_address), array('timeout' => 2));
+				$country_code     = sanitize_text_field(strtoupper(self::handle_geolocation_response($response, $service_name)));
 
-				if ( ! empty( $country_code ) ) {
+				if (!empty($country_code)) {
 					break;
 				}
 
 			}
 
-			set_transient( 'geoip_' . $ip_address, $country_code, WEEK_IN_SECONDS );
+			set_transient('geoip_' . $ip_address, $country_code, WEEK_IN_SECONDS);
 		}
 
 		return $country_code;
@@ -253,23 +253,23 @@ 
 	 * @param  String $geolocation_service
 	 * @return string Country code
 	 */
-	protected static function handle_geolocation_response( $geolocation_response, $geolocation_service ) {
+	protected static function handle_geolocation_response($geolocation_response, $geolocation_service) {
 
-		if ( is_wp_error( $geolocation_response ) || empty( $geolocation_response['body'] ) ) {
+		if (is_wp_error($geolocation_response) || empty($geolocation_response['body'])) {
 			return '';
 		}
 
-		if ( $geolocation_service === 'ipinfo.io' ) {
-			$data = json_decode( $geolocation_response['body'] );
-			return empty( $data ) || empty( $data->country ) ? '' : $data->country;
+		if ($geolocation_service === 'ipinfo.io') {
+			$data = json_decode($geolocation_response['body']);
+			return empty($data) || empty($data->country) ? '' : $data->country;
 		}
 
-		if ( $geolocation_service === 'ip-api.com' ) {
-			$data = json_decode( $geolocation_response['body'] );
-			return empty( $data ) || empty( $data->countryCode ) ? '' : $data->countryCode;
+		if ($geolocation_service === 'ip-api.com') {
+			$data = json_decode($geolocation_response['body']);
+			return empty($data) || empty($data->countryCode) ? '' : $data->countryCode;
 		}
 
-		return apply_filters( 'getpaid_geolocation_geoip_response_' . $geolocation_service, '', $geolocation_response['body'] );
+		return apply_filters('getpaid_geolocation_geoip_response_' . $geolocation_service, '', $geolocation_response['body']);
 
 	}
 

includes/class-wpinv-session-handler.php

Indentation +274 added lines, -274 removed lines

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

Spacing +55 added lines, -55 removed lines

@@ -5,7 +5,7 @@ 
  *
  */
 
-defined( 'ABSPATH' ) || exit;
+defined('ABSPATH') || exit;
 
 /**
  * Session handler class.
@@ -52,11 +52,11 @@ 
 	 */
 	public function __construct() {
 
-	    $this->_cookie = apply_filters( 'wpinv_cookie', 'wpinv_session_' . COOKIEHASH );
-        add_action( 'init', array( $this, 'init' ), -1 );
-		add_action( 'wp_logout', array( $this, 'destroy_session' ) );
-		add_action( 'wp', array( $this, 'set_customer_session_cookie' ), 10 );
-		add_action( 'shutdown', array( $this, 'save_data' ), 20 );
+	    $this->_cookie = apply_filters('wpinv_cookie', 'wpinv_session_' . COOKIEHASH);
+        add_action('init', array($this, 'init'), -1);
+		add_action('wp_logout', array($this, 'destroy_session'));
+		add_action('wp', array($this, 'set_customer_session_cookie'), 10);
+		add_action('shutdown', array($this, 'save_data'), 20);
 
 	}
 
@@ -68,8 +68,8 @@ 
 	public function init() {
 		$this->init_session_cookie();
 
-		if ( ! is_user_logged_in() ) {
-			add_filter( 'nonce_user_logged_out', array( $this, 'nonce_user_logged_out' ), 10, 2 );
+		if (!is_user_logged_in()) {
+			add_filter('nonce_user_logged_out', array($this, 'nonce_user_logged_out'), 10, 2);
 		}
 	}
 
@@ -81,7 +81,7 @@ 
 	public function init_session_cookie() {
 		$cookie = $this->get_session_cookie();
 
-		if ( $cookie ) {
+		if ($cookie) {
 			$this->_customer_id        = $cookie[0];
 			$this->_session_expiration = $cookie[1];
 			$this->_session_expiring   = $cookie[2];
@@ -89,17 +89,17 @@ 
 			$this->_data               = $this->get_session_data();
 
 			// If the user logs in, update session.
-			if ( is_user_logged_in() && get_current_user_id() != $this->_customer_id ) {
+			if (is_user_logged_in() && get_current_user_id() != $this->_customer_id) {
 				$this->_customer_id = get_current_user_id();
 				$this->_dirty       = true;
 				$this->save_data();
-				$this->set_customer_session_cookie( true );
+				$this->set_customer_session_cookie(true);
 			}
 
 			// Update session if its close to expiring.
-			if ( time() > $this->_session_expiring ) {
+			if (time() > $this->_session_expiring) {
 				$this->set_session_expiration();
-				$this->update_session_timestamp( $this->_customer_id, $this->_session_expiration );
+				$this->update_session_timestamp($this->_customer_id, $this->_session_expiration);
 			}
 		} else {
 			$this->set_session_expiration();
@@ -117,25 +117,25 @@ 
 	 *
 	 * @param bool $set Should the session cookie be set.
 	 */
-	public function set_customer_session_cookie( $set ) {
-		if ( $set ) {
+	public function set_customer_session_cookie($set) {
+		if ($set) {
 			$to_hash           = $this->_customer_id . '|' . $this->_session_expiration;
-			$cookie_hash       = hash_hmac( 'md5', $to_hash, wp_hash( $to_hash ) );
+			$cookie_hash       = hash_hmac('md5', $to_hash, wp_hash($to_hash));
 			$cookie_value      = $this->_customer_id . '||' . $this->_session_expiration . '||' . $this->_session_expiring . '||' . $cookie_hash;
 			$this->_has_cookie = true;
 
-			if ( ! isset( $_COOKIE[ $this->_cookie ] ) || $_COOKIE[ $this->_cookie ] !== $cookie_value ) {
-				$this->setcookie( $this->_cookie, $cookie_value, $this->_session_expiration, $this->use_secure_cookie(), true );
+			if (!isset($_COOKIE[$this->_cookie]) || $_COOKIE[$this->_cookie] !== $cookie_value) {
+				$this->setcookie($this->_cookie, $cookie_value, $this->_session_expiration, $this->use_secure_cookie(), true);
 			}
 		}
 	}
 
-	public function setcookie($name, $value, $expire = 0, $secure = false, $httponly = false){
-        if ( ! headers_sent() ) {
-            setcookie( $name, $value, $expire, COOKIEPATH ? COOKIEPATH : '/', COOKIE_DOMAIN, $secure, apply_filters( 'wpinv_cookie_httponly', $httponly, $name, $value, $expire, $secure ) );
-        } elseif ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
-            headers_sent( $file, $line );
-            trigger_error( "{$name} cookie cannot be set - headers already sent by {$file} on line {$line}", E_USER_NOTICE ); // @codingStandardsIgnoreLine
+	public function setcookie($name, $value, $expire = 0, $secure = false, $httponly = false) {
+        if (!headers_sent()) {
+            setcookie($name, $value, $expire, COOKIEPATH ? COOKIEPATH : '/', COOKIE_DOMAIN, $secure, apply_filters('wpinv_cookie_httponly', $httponly, $name, $value, $expire, $secure));
+        } elseif (defined('WP_DEBUG') && WP_DEBUG) {
+            headers_sent($file, $line);
+            trigger_error("{$name} cookie cannot be set - headers already sent by {$file} on line {$line}", E_USER_NOTICE); // @codingStandardsIgnoreLine
         }
     }
 
@@ -146,8 +146,8 @@ 
 	 * @return bool
 	 */
 	protected function use_secure_cookie() {
-        $is_https = false !== strstr( get_option( 'home' ), 'https:' );
-		return apply_filters( 'wpinv_session_use_secure_cookie', $is_https && is_ssl() );
+        $is_https = false !== strstr(get_option('home'), 'https:');
+		return apply_filters('wpinv_session_use_secure_cookie', $is_https && is_ssl());
 	}
 
 	/**
@@ -156,15 +156,15 @@ 
 	 * @return bool
 	 */
 	public function has_session() {
-		return isset( $_COOKIE[ $this->_cookie ] ) || $this->_has_cookie || is_user_logged_in(); // @codingStandardsIgnoreLine.
+		return isset($_COOKIE[$this->_cookie]) || $this->_has_cookie || is_user_logged_in(); // @codingStandardsIgnoreLine.
 	}
 
 	/**
 	 * Set session expiration.
 	 */
 	public function set_session_expiration() {
-		$this->_session_expiring   = time() + intval( apply_filters( 'wpinv_session_expiring', 60 * 60 * 47 ) ); // 47 Hours.
-		$this->_session_expiration = time() + intval( apply_filters( 'wpinv_session_expiration', 60 * 60 * 48 ) ); // 48 Hours.
+		$this->_session_expiring   = time() + intval(apply_filters('wpinv_session_expiring', 60 * 60 * 47)); // 47 Hours.
+		$this->_session_expiration = time() + intval(apply_filters('wpinv_session_expiration', 60 * 60 * 48)); // 48 Hours.
 	}
 
 	/**
@@ -174,8 +174,8 @@ 
 	 */
 	public function generate_customer_id() {
 		require_once ABSPATH . 'wp-includes/class-phpass.php';
-		$hasher      = new PasswordHash( 8, false );
-		return md5( $hasher->get_random_bytes( 32 ) );
+		$hasher = new PasswordHash(8, false);
+		return md5($hasher->get_random_bytes(32));
 	}
 
 	/**
@@ -186,27 +186,27 @@ 
 	 * @return bool|array
 	 */
 	public function get_session_cookie() {
-		$cookie_value = isset( $_COOKIE[ $this->_cookie ] ) ? wp_unslash( $_COOKIE[ $this->_cookie ] ) : false; // @codingStandardsIgnoreLine.
+		$cookie_value = isset($_COOKIE[$this->_cookie]) ? wp_unslash($_COOKIE[$this->_cookie]) : false; // @codingStandardsIgnoreLine.
 
-		if ( empty( $cookie_value ) || ! is_string( $cookie_value ) ) {
+		if (empty($cookie_value) || !is_string($cookie_value)) {
 			return false;
 		}
 
-		list( $customer_id, $session_expiration, $session_expiring, $cookie_hash ) = explode( '||', $cookie_value );
+		list($customer_id, $session_expiration, $session_expiring, $cookie_hash) = explode('||', $cookie_value);
 
-		if ( empty( $customer_id ) ) {
+		if (empty($customer_id)) {
 			return false;
 		}
 
 		// Validate hash.
 		$to_hash = $customer_id . '|' . $session_expiration;
-		$hash    = hash_hmac( 'md5', $to_hash, wp_hash( $to_hash ) );
+		$hash    = hash_hmac('md5', $to_hash, wp_hash($to_hash));
 
-		if ( empty( $cookie_hash ) || ! hash_equals( $hash, $cookie_hash ) ) {
+		if (empty($cookie_hash) || !hash_equals($hash, $cookie_hash)) {
 			return false;
 		}
 
-		return array( $customer_id, $session_expiration, $session_expiring, $cookie_hash );
+		return array($customer_id, $session_expiration, $session_expiring, $cookie_hash);
 	}
 
 	/**
@@ -215,15 +215,15 @@ 
 	 * @return array
 	 */
 	public function get_session_data() {
-		return $this->has_session() ? (array) $this->get_session( $this->_customer_id ) : array();
+		return $this->has_session() ? (array) $this->get_session($this->_customer_id) : array();
 	}
 
-	public function generate_key($customer_id){
-        if(!$customer_id){
+	public function generate_key($customer_id) {
+        if (!$customer_id) {
             return;
         }
 
-        return 'wpi_trans_'.$customer_id;
+        return 'wpi_trans_' . $customer_id;
     }
 
 	/**
@@ -231,9 +231,9 @@ 
 	 */
 	public function save_data() {
 		// Dirty if something changed - prevents saving nothing new.
-		if ( $this->_dirty && $this->has_session() ) {
+		if ($this->_dirty && $this->has_session()) {
 
-            set_transient( $this->generate_key($this->_customer_id), $this->_data, $this->_session_expiration);
+            set_transient($this->generate_key($this->_customer_id), $this->_data, $this->_session_expiration);
 
 			$this->_dirty = false;
 		}
@@ -243,7 +243,7 @@ 
 	 * Destroy all session data.
 	 */
 	public function destroy_session() {
-		$this->delete_session( $this->_customer_id );
+		$this->delete_session($this->_customer_id);
 		$this->forget_session();
 	}
 
@@ -251,7 +251,7 @@ 
 	 * Forget all session data without destroying it.
 	 */
 	public function forget_session() {
-		$this->setcookie( $this->_cookie, '', time() - YEAR_IN_SECONDS, $this->use_secure_cookie(), true );
+		$this->setcookie($this->_cookie, '', time() - YEAR_IN_SECONDS, $this->use_secure_cookie(), true);
 
 		wpinv_empty_cart();
 
@@ -266,10 +266,10 @@ 
 	 * @param int $uid User ID.
 	 * @return string
 	 */
-	public function nonce_user_logged_out( $uid ) {
+	public function nonce_user_logged_out($uid) {
 
 		// Check if one of our nonces.
-		if ( substr( $uid, 0, 5 ) === 'wpinv' || substr( $uid, 0, 7 ) === 'getpaid' ) {
+		if (substr($uid, 0, 5) === 'wpinv' || substr($uid, 0, 7) === 'getpaid') {
 			return $this->has_session() && $this->_customer_id ? $this->_customer_id : $uid;
 		}
 
@@ -283,20 +283,20 @@ 
 	 * @param mixed  $default Default session value.
 	 * @return string|array
 	 */
-	public function get_session( $customer_id, $default = false ) {
+	public function get_session($customer_id, $default = false) {
 
-		if ( defined( 'WP_SETUP_CONFIG' ) ) {
+		if (defined('WP_SETUP_CONFIG')) {
 			return array();
 		}
 
         $key = $this->generate_key($customer_id);
         $value = get_transient($key);
 
-        if ( !$value ) {
+        if (!$value) {
             $value = $default;
         }
 
-		return maybe_unserialize( $value );
+		return maybe_unserialize($value);
 	}
 
 	/**
@@ -304,7 +304,7 @@ 
 	 *
 	 * @param int $customer_id Customer ID.
 	 */
-	public function delete_session( $customer_id ) {
+	public function delete_session($customer_id) {
 
         $key = $this->generate_key($customer_id);
 
@@ -317,9 +317,9 @@ 
 	 * @param string $customer_id Customer ID.
 	 * @param int    $timestamp Timestamp to expire the cookie.
 	 */
-	public function update_session_timestamp( $customer_id, $timestamp ) {
+	public function update_session_timestamp($customer_id, $timestamp) {
 
-        set_transient( $this->generate_key($customer_id), maybe_serialize( $this->_data ), $timestamp);
+        set_transient($this->generate_key($customer_id), maybe_serialize($this->_data), $timestamp);
 
 	}
 }