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' ) ),
+            ),
+        );
+    }
 }

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

Indentation +189 added lines, -189 removed lines

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

includes/reports/class-getpaid-reports.php

Indentation +115 added lines, -115 removed lines

@@ -12,49 +12,49 @@ 
  */
 class GetPaid_Reports {
 
-	/**
-	 * Class constructor.
-	 *
-	 */
-	public function __construct() {
-		add_action( 'admin_menu', array( $this, 'register_reports_page' ), 20 );
-		add_action( 'wpinv_reports_tab_reports', array( $this, 'display_reports_tab' ) );
-		add_action( 'wpinv_reports_tab_export', array( $this, 'display_exports_tab' ) );
-		add_action( 'getpaid_authenticated_admin_action_download_graph', array( $this, 'download_graph' ) );
-		add_action( 'getpaid_authenticated_admin_action_export_invoices', array( $this, 'export_invoices' ) );
-
-	}
-
-	/**
-	 * Registers the reports page.
-	 *
-	 */
-	public function register_reports_page() {
-
-		add_submenu_page(
+    /**
+     * Class constructor.
+     *
+     */
+    public function __construct() {
+        add_action( 'admin_menu', array( $this, 'register_reports_page' ), 20 );
+        add_action( 'wpinv_reports_tab_reports', array( $this, 'display_reports_tab' ) );
+        add_action( 'wpinv_reports_tab_export', array( $this, 'display_exports_tab' ) );
+        add_action( 'getpaid_authenticated_admin_action_download_graph', array( $this, 'download_graph' ) );
+        add_action( 'getpaid_authenticated_admin_action_export_invoices', array( $this, 'export_invoices' ) );
+
+    }
+
+    /**
+     * Registers the reports page.
+     *
+     */
+    public function register_reports_page() {
+
+        add_submenu_page(
             'wpinv',
             __( 'Reports', 'invoicing' ),
             __( 'Reports', 'invoicing' ),
             wpinv_get_capability(),
             'wpinv-reports',
             array( $this, 'display_reports_page' )
-		);
+        );
 
-	}
+    }
 
-	/**
-	 * Displays the reports page.
-	 *
-	 */
-	public function display_reports_page() {
+    /**
+     * Displays the reports page.
+     *
+     */
+    public function display_reports_page() {
 
-		// Prepare variables.
-		$tabs        = $this->get_tabs();
-		$current_tab = isset( $_GET['tab'] ) ? sanitize_text_field( $_GET['tab'] ) : 'reports';
-		$current_tab = array_key_exists( $current_tab, $tabs ) ? $current_tab : 'reports';
+        // Prepare variables.
+        $tabs        = $this->get_tabs();
+        $current_tab = isset( $_GET['tab'] ) ? sanitize_text_field( $_GET['tab'] ) : 'reports';
+        $current_tab = array_key_exists( $current_tab, $tabs ) ? $current_tab : 'reports';
 
-		// Display the current tab.
-		?>
+        // Display the current tab.
+        ?>
 
         <div class="wrap">
 
@@ -63,19 +63,19 @@ 
 			<nav class="nav-tab-wrapper">
 
 				<?php
-					foreach( $tabs as $key => $label ) {
+                    foreach( $tabs as $key => $label ) {
 
-						$key   = sanitize_text_field( $key );
-						$label = sanitize_text_field( $label );
-						$class = $key == $current_tab ? 'nav-tab nav-tab-active' : 'nav-tab';
-						$url   = esc_url(
-							add_query_arg( 'tab', $key, admin_url( 'admin.php?page=wpinv-reports' ) )
-						);
+                        $key   = sanitize_text_field( $key );
+                        $label = sanitize_text_field( $label );
+                        $class = $key == $current_tab ? 'nav-tab nav-tab-active' : 'nav-tab';
+                        $url   = esc_url(
+                            add_query_arg( 'tab', $key, admin_url( 'admin.php?page=wpinv-reports' ) )
+                        );
 
-						echo "\n\t\t\t<a href='$url' class='$class'>$label</a>";
+                        echo "\n\t\t\t<a href='$url' class='$class'>$label</a>";
 
-					}
-				?>
+                    }
+                ?>
 
 			</nav>
 
@@ -86,77 +86,77 @@ 
         </div>
 		<?php
 
-			// Wordfence loads an unsupported version of chart js on our page.
-			wp_deregister_style( 'chart-js' );
-			wp_deregister_script( 'chart-js' );
-			wp_enqueue_script( 'chart-js', WPINV_PLUGIN_URL . 'assets/js/chart.bundle.min.js', array( 'jquery' ), '2.9.4', true );
-			wp_enqueue_style( 'chart-js', WPINV_PLUGIN_URL . 'assets/css/chart.min.css', array(), '2.9.4' );
-
-	}
-
-	/**
-	 * Retrieves reports page tabs.
-	 *
-	 * @return array
-	 */
-	public function get_tabs() {
-
-		$tabs = array(
-			'reports' => __( 'Reports', 'invoicing' ),
-			'export'  => __( 'Export', 'invoicing' ),
-		);
-
-		return apply_filters( 'getpaid_report_tabs', $tabs );
-	}
-
-	/**
-	 * Displays the reports tab.
-	 *
-	 */
-	public function display_reports_tab() {
-
-		$reports = new GetPaid_Reports_Report();
-		$reports->display();
-
-	}
-
-	/**
-	 * Displays the exports tab.
-	 *
-	 */
-	public function display_exports_tab() {
-
-		$exports = new GetPaid_Reports_Export();
-		$exports->display();
-
-	}
-
-	/**
-	 * Donwnloads a graph.
-	 *
-	 * @param array $args
-	 */
-	public function download_graph( $args ) {
-
-		if ( ! empty( $args['graph'] ) ) {
-			$downloader = new GetPaid_Graph_Downloader();
-			$downloader->download( $args['graph'] );
-		}
-
-	}
-
-	/**
-	 * Exports invoices.
-	 *
-	 * @param array $args
-	 */
-	public function export_invoices( $args ) {
-
-		if ( ! empty( $args['post_type'] ) ) {
-			$downloader = new GetPaid_Invoice_Exporter();
-			$downloader->export( $args['post_type'], $args );
-		}
-
-	}
+            // Wordfence loads an unsupported version of chart js on our page.
+            wp_deregister_style( 'chart-js' );
+            wp_deregister_script( 'chart-js' );
+            wp_enqueue_script( 'chart-js', WPINV_PLUGIN_URL . 'assets/js/chart.bundle.min.js', array( 'jquery' ), '2.9.4', true );
+            wp_enqueue_style( 'chart-js', WPINV_PLUGIN_URL . 'assets/css/chart.min.css', array(), '2.9.4' );
+
+    }
+
+    /**
+     * Retrieves reports page tabs.
+     *
+     * @return array
+     */
+    public function get_tabs() {
+
+        $tabs = array(
+            'reports' => __( 'Reports', 'invoicing' ),
+            'export'  => __( 'Export', 'invoicing' ),
+        );
+
+        return apply_filters( 'getpaid_report_tabs', $tabs );
+    }
+
+    /**
+     * Displays the reports tab.
+     *
+     */
+    public function display_reports_tab() {
+
+        $reports = new GetPaid_Reports_Report();
+        $reports->display();
+
+    }
+
+    /**
+     * Displays the exports tab.
+     *
+     */
+    public function display_exports_tab() {
+
+        $exports = new GetPaid_Reports_Export();
+        $exports->display();
+
+    }
+
+    /**
+     * Donwnloads a graph.
+     *
+     * @param array $args
+     */
+    public function download_graph( $args ) {
+
+        if ( ! empty( $args['graph'] ) ) {
+            $downloader = new GetPaid_Graph_Downloader();
+            $downloader->download( $args['graph'] );
+        }
+
+    }
+
+    /**
+     * Exports invoices.
+     *
+     * @param array $args
+     */
+    public function export_invoices( $args ) {
+
+        if ( ! empty( $args['post_type'] ) ) {
+            $downloader = new GetPaid_Invoice_Exporter();
+            $downloader->export( $args['post_type'], $args );
+        }
+
+    }
 
 }

includes/class-getpaid-post-types.php

Indentation +294 added lines, -294 removed lines

@@ -15,319 +15,319 @@
 class GetPaid_Post_Types {
 
     /**
-	 * Hook in methods.
-	 */
-	public function __construct() {
-		add_action( 'init', array( __CLASS__, 'register_post_types' ), 1 );
-		add_action( 'init', array( __CLASS__, 'register_post_status' ), 4 );
-		add_action( 'getpaid_flush_rewrite_rules', array( __CLASS__, 'flush_rewrite_rules' ) );
-		add_action( 'getpaid_after_register_post_types', array( __CLASS__, 'maybe_flush_rewrite_rules' ) );
-	}
+     * Hook in methods.
+     */
+    public function __construct() {
+        add_action( 'init', array( __CLASS__, 'register_post_types' ), 1 );
+        add_action( 'init', array( __CLASS__, 'register_post_status' ), 4 );
+        add_action( 'getpaid_flush_rewrite_rules', array( __CLASS__, 'flush_rewrite_rules' ) );
+        add_action( 'getpaid_after_register_post_types', array( __CLASS__, 'maybe_flush_rewrite_rules' ) );
+    }
 
-	/**
-	 * Register core post types.
-	 */
-	public static function register_post_types() {
+    /**
+     * Register core post types.
+     */
+    public static function register_post_types() {
 
-		if ( ! is_blog_installed() || post_type_exists( 'wpi_item' ) ) {
-			return;
-		}
+        if ( ! is_blog_installed() || post_type_exists( 'wpi_item' ) ) {
+            return;
+        }
 
-		// Fires before registering post types.
-		do_action( 'getpaid_register_post_types' );
+        // Fires before registering post types.
+        do_action( 'getpaid_register_post_types' );
 
-		// Register item post type.
-		register_post_type(
-			'wpi_item',
-			apply_filters(
-				'wpinv_register_post_type_invoice_item',
-				array(
-					'labels'             => array(
-						'name'               => _x( 'Items', 'post type general name', 'invoicing' ),
-						'singular_name'      => _x( 'Item', 'post type singular name', 'invoicing' ),
-						'menu_name'          => _x( 'Items', 'admin menu', 'invoicing' ),
-						'name_admin_bar'     => _x( 'Item', 'add new on admin bar', 'invoicing' ),
-						'add_new'            => _x( 'Add New', 'Item', 'invoicing' ),
-						'add_new_item'       => __( 'Add New Item', 'invoicing' ),
-						'new_item'           => __( 'New Item', 'invoicing' ),
-						'edit_item'          => __( 'Edit Item', 'invoicing' ),
-						'view_item'          => __( 'View Item', 'invoicing' ),
-						'all_items'          => __( 'Items', 'invoicing' ),
-						'search_items'       => __( 'Search items', 'invoicing' ),
-						'parent_item_colon'  => __( 'Parent item:', 'invoicing' ),
-						'not_found'          => __( 'No items found.', 'invoicing' ),
-						'not_found_in_trash' => __( 'No items found in trash.', 'invoicing' )
-					),
-					'description'           => __( 'This is where you can add new invoice items.', 'invoicing' ),
-					'public'                => false,
-					'has_archive'           => false,
-					'_builtin'              => false,
-					'show_ui'               => true,
-					'show_in_menu'          => wpinv_current_user_can_manage_invoicing() ? 'wpinv' : false,
-					'show_in_nav_menus'     => false,
-					'supports'              => array( 'title', 'excerpt', 'thumbnail' ),
-					'rewrite'               => false,
-					'query_var'             => false,
-					'map_meta_cap'          => true,
-					'show_in_admin_bar'     => true,
-					'can_export'            => true,
-				)
-			)
-		);
+        // Register item post type.
+        register_post_type(
+            'wpi_item',
+            apply_filters(
+                'wpinv_register_post_type_invoice_item',
+                array(
+                    'labels'             => array(
+                        'name'               => _x( 'Items', 'post type general name', 'invoicing' ),
+                        'singular_name'      => _x( 'Item', 'post type singular name', 'invoicing' ),
+                        'menu_name'          => _x( 'Items', 'admin menu', 'invoicing' ),
+                        'name_admin_bar'     => _x( 'Item', 'add new on admin bar', 'invoicing' ),
+                        'add_new'            => _x( 'Add New', 'Item', 'invoicing' ),
+                        'add_new_item'       => __( 'Add New Item', 'invoicing' ),
+                        'new_item'           => __( 'New Item', 'invoicing' ),
+                        'edit_item'          => __( 'Edit Item', 'invoicing' ),
+                        'view_item'          => __( 'View Item', 'invoicing' ),
+                        'all_items'          => __( 'Items', 'invoicing' ),
+                        'search_items'       => __( 'Search items', 'invoicing' ),
+                        'parent_item_colon'  => __( 'Parent item:', 'invoicing' ),
+                        'not_found'          => __( 'No items found.', 'invoicing' ),
+                        'not_found_in_trash' => __( 'No items found in trash.', 'invoicing' )
+                    ),
+                    'description'           => __( 'This is where you can add new invoice items.', 'invoicing' ),
+                    'public'                => false,
+                    'has_archive'           => false,
+                    '_builtin'              => false,
+                    'show_ui'               => true,
+                    'show_in_menu'          => wpinv_current_user_can_manage_invoicing() ? 'wpinv' : false,
+                    'show_in_nav_menus'     => false,
+                    'supports'              => array( 'title', 'excerpt', 'thumbnail' ),
+                    'rewrite'               => false,
+                    'query_var'             => false,
+                    'map_meta_cap'          => true,
+                    'show_in_admin_bar'     => true,
+                    'can_export'            => true,
+                )
+            )
+        );
 
-		// Register payment form post type.
-		register_post_type(
-			'wpi_payment_form',
-			apply_filters(
-				'wpinv_register_post_type_payment_form',
-				array(
-					'labels'             => array(
-						'name'               => _x( 'Payment Forms', 'post type general name', 'invoicing' ),
-						'singular_name'      => _x( 'Payment Form', 'post type singular name', 'invoicing' ),
-						'menu_name'          => _x( 'Payment Forms', 'admin menu', 'invoicing' ),
-						'name_admin_bar'     => _x( 'Payment Form', 'add new on admin bar', 'invoicing' ),
-						'add_new'            => _x( 'Add New', 'Payment Form', 'invoicing' ),
-						'add_new_item'       => __( 'Add New Payment Form', 'invoicing' ),
-						'new_item'           => __( 'New Payment Form', 'invoicing' ),
-						'edit_item'          => __( 'Edit Payment Form', 'invoicing' ),
-						'view_item'          => __( 'View Payment Form', 'invoicing' ),
-						'all_items'          => __( 'Payment Forms', 'invoicing' ),
-						'search_items'       => __( 'Search Payment Forms', 'invoicing' ),
-						'parent_item_colon'  => __( 'Parent Payment Forms:', 'invoicing' ),
-						'not_found'          => __( 'No payment forms found.', 'invoicing' ),
-						'not_found_in_trash' => __( 'No payment forms found in trash.', 'invoicing' )
-					),
-					'description'        => __( 'Add new payment forms.', 'invoicing' ),
-					'public'             => false,
-					'show_ui'            => true,
-					'show_in_menu'       => wpinv_current_user_can_manage_invoicing() ? 'wpinv' : true,
-					'show_in_nav_menus'  => false,
-					'query_var'          => false,
-					'rewrite'            => true,
-					'map_meta_cap'       => true,
-					'has_archive'        => false,
-					'hierarchical'       => false,
-					'menu_position'      => null,
-					'supports'           => array( 'title' ),
-					'menu_icon'          => 'dashicons-media-form',
-				)
-			)
-		);
+        // Register payment form post type.
+        register_post_type(
+            'wpi_payment_form',
+            apply_filters(
+                'wpinv_register_post_type_payment_form',
+                array(
+                    'labels'             => array(
+                        'name'               => _x( 'Payment Forms', 'post type general name', 'invoicing' ),
+                        'singular_name'      => _x( 'Payment Form', 'post type singular name', 'invoicing' ),
+                        'menu_name'          => _x( 'Payment Forms', 'admin menu', 'invoicing' ),
+                        'name_admin_bar'     => _x( 'Payment Form', 'add new on admin bar', 'invoicing' ),
+                        'add_new'            => _x( 'Add New', 'Payment Form', 'invoicing' ),
+                        'add_new_item'       => __( 'Add New Payment Form', 'invoicing' ),
+                        'new_item'           => __( 'New Payment Form', 'invoicing' ),
+                        'edit_item'          => __( 'Edit Payment Form', 'invoicing' ),
+                        'view_item'          => __( 'View Payment Form', 'invoicing' ),
+                        'all_items'          => __( 'Payment Forms', 'invoicing' ),
+                        'search_items'       => __( 'Search Payment Forms', 'invoicing' ),
+                        'parent_item_colon'  => __( 'Parent Payment Forms:', 'invoicing' ),
+                        'not_found'          => __( 'No payment forms found.', 'invoicing' ),
+                        'not_found_in_trash' => __( 'No payment forms found in trash.', 'invoicing' )
+                    ),
+                    'description'        => __( 'Add new payment forms.', 'invoicing' ),
+                    'public'             => false,
+                    'show_ui'            => true,
+                    'show_in_menu'       => wpinv_current_user_can_manage_invoicing() ? 'wpinv' : true,
+                    'show_in_nav_menus'  => false,
+                    'query_var'          => false,
+                    'rewrite'            => true,
+                    'map_meta_cap'       => true,
+                    'has_archive'        => false,
+                    'hierarchical'       => false,
+                    'menu_position'      => null,
+                    'supports'           => array( 'title' ),
+                    'menu_icon'          => 'dashicons-media-form',
+                )
+            )
+        );
 
-		// Register invoice post type.
-		register_post_type(
-			'wpi_invoice',
-			apply_filters(
-				'wpinv_register_post_type_invoice',
-				array(
-					'labels'                 => array(
-						'name'                  => __( 'Invoices', 'invoicing' ),
-						'singular_name'         => __( 'Invoice', 'invoicing' ),
-						'all_items'             => __( 'Invoices', 'invoicing' ),
-						'menu_name'             => _x( 'Invoices', 'Admin menu name', 'invoicing' ),
-						'add_new'               => __( 'Add New', 'invoicing' ),
-						'add_new_item'          => __( 'Add new invoice', 'invoicing' ),
-						'edit'                  => __( 'Edit', 'invoicing' ),
-						'edit_item'             => __( 'Edit invoice', 'invoicing' ),
-						'new_item'              => __( 'New invoice', 'invoicing' ),
-						'view_item'             => __( 'View invoice', 'invoicing' ),
-						'view_items'            => __( 'View Invoices', 'invoicing' ),
-						'search_items'          => __( 'Search invoices', 'invoicing' ),
-						'not_found'             => __( 'No invoices found', 'invoicing' ),
-						'not_found_in_trash'    => __( 'No invoices found in trash', 'invoicing' ),
-						'parent'                => __( 'Parent invoice', 'invoicing' ),
-						'featured_image'        => __( 'Invoice image', 'invoicing' ),
-						'set_featured_image'    => __( 'Set invoice image', 'invoicing' ),
-						'remove_featured_image' => __( 'Remove invoice image', 'invoicing' ),
-						'use_featured_image'    => __( 'Use as invoice image', 'invoicing' ),
-						'insert_into_item'      => __( 'Insert into invoice', 'invoicing' ),
-						'uploaded_to_this_item' => __( 'Uploaded to this invoice', 'invoicing' ),
-						'filter_items_list'     => __( 'Filter invoices', 'invoicing' ),
-						'items_list_navigation' => __( 'Invoices navigation', 'invoicing' ),
-						'items_list'            => __( 'Invoices list', 'invoicing' ),
-					),
-					'description'           => __( 'This is where invoices are stored.', 'invoicing' ),
-					'public'                => true,
-					'has_archive'           => false,
-					'publicly_queryable'    => true,
-        			'exclude_from_search'   => true,
-        			'show_ui'               => true,
-					'show_in_menu'          => wpinv_current_user_can_manage_invoicing() ? 'wpinv' : false,
-					'show_in_nav_menus'     => false,
-					'supports'              => array( 'title', 'author', 'excerpt'  ),
-					'rewrite'               => array(
-						'slug'              => 'invoice',
-						'with_front'        => false,
-					),
-					'query_var'             => false,
-					'map_meta_cap'          => true,
-					'show_in_admin_bar'     => true,
-					'can_export'            => true,
-					'hierarchical'          => false,
-					'menu_position'         => null,
-					'menu_icon'             => 'dashicons-media-spreadsheet',
-				)
-			)
-		);
+        // Register invoice post type.
+        register_post_type(
+            'wpi_invoice',
+            apply_filters(
+                'wpinv_register_post_type_invoice',
+                array(
+                    'labels'                 => array(
+                        'name'                  => __( 'Invoices', 'invoicing' ),
+                        'singular_name'         => __( 'Invoice', 'invoicing' ),
+                        'all_items'             => __( 'Invoices', 'invoicing' ),
+                        'menu_name'             => _x( 'Invoices', 'Admin menu name', 'invoicing' ),
+                        'add_new'               => __( 'Add New', 'invoicing' ),
+                        'add_new_item'          => __( 'Add new invoice', 'invoicing' ),
+                        'edit'                  => __( 'Edit', 'invoicing' ),
+                        'edit_item'             => __( 'Edit invoice', 'invoicing' ),
+                        'new_item'              => __( 'New invoice', 'invoicing' ),
+                        'view_item'             => __( 'View invoice', 'invoicing' ),
+                        'view_items'            => __( 'View Invoices', 'invoicing' ),
+                        'search_items'          => __( 'Search invoices', 'invoicing' ),
+                        'not_found'             => __( 'No invoices found', 'invoicing' ),
+                        'not_found_in_trash'    => __( 'No invoices found in trash', 'invoicing' ),
+                        'parent'                => __( 'Parent invoice', 'invoicing' ),
+                        'featured_image'        => __( 'Invoice image', 'invoicing' ),
+                        'set_featured_image'    => __( 'Set invoice image', 'invoicing' ),
+                        'remove_featured_image' => __( 'Remove invoice image', 'invoicing' ),
+                        'use_featured_image'    => __( 'Use as invoice image', 'invoicing' ),
+                        'insert_into_item'      => __( 'Insert into invoice', 'invoicing' ),
+                        'uploaded_to_this_item' => __( 'Uploaded to this invoice', 'invoicing' ),
+                        'filter_items_list'     => __( 'Filter invoices', 'invoicing' ),
+                        'items_list_navigation' => __( 'Invoices navigation', 'invoicing' ),
+                        'items_list'            => __( 'Invoices list', 'invoicing' ),
+                    ),
+                    'description'           => __( 'This is where invoices are stored.', 'invoicing' ),
+                    'public'                => true,
+                    'has_archive'           => false,
+                    'publicly_queryable'    => true,
+                    'exclude_from_search'   => true,
+                    'show_ui'               => true,
+                    'show_in_menu'          => wpinv_current_user_can_manage_invoicing() ? 'wpinv' : false,
+                    'show_in_nav_menus'     => false,
+                    'supports'              => array( 'title', 'author', 'excerpt'  ),
+                    'rewrite'               => array(
+                        'slug'              => 'invoice',
+                        'with_front'        => false,
+                    ),
+                    'query_var'             => false,
+                    'map_meta_cap'          => true,
+                    'show_in_admin_bar'     => true,
+                    'can_export'            => true,
+                    'hierarchical'          => false,
+                    'menu_position'         => null,
+                    'menu_icon'             => 'dashicons-media-spreadsheet',
+                )
+            )
+        );
 
-		// Register discount post type.
-		register_post_type(
-			'wpi_discount',
-			apply_filters(
-				'wpinv_register_post_type_discount',
-				array(
-					'labels'                 => array(
-						'name'                  => __( 'Discounts', 'invoicing' ),
-						'singular_name'         => __( 'Discount', 'invoicing' ),
-						'all_items'             => __( 'Discounts', 'invoicing' ),
-						'menu_name'             => _x( 'Discounts', 'Admin menu name', 'invoicing' ),
-						'add_new'               => __( 'Add New', 'invoicing' ),
-						'add_new_item'          => __( 'Add new discount', 'invoicing' ),
-						'edit'                  => __( 'Edit', 'invoicing' ),
-						'edit_item'             => __( 'Edit discount', 'invoicing' ),
-						'new_item'              => __( 'New discount', 'invoicing' ),
-						'view_item'             => __( 'View discount', 'invoicing' ),
-						'view_items'            => __( 'View Discounts', 'invoicing' ),
-						'search_items'          => __( 'Search discounts', 'invoicing' ),
-						'not_found'             => __( 'No discounts found', 'invoicing' ),
-						'not_found_in_trash'    => __( 'No discounts found in trash', 'invoicing' ),
-						'parent'                => __( 'Parent discount', 'invoicing' ),
-						'featured_image'        => __( 'Discount image', 'invoicing' ),
-						'set_featured_image'    => __( 'Set discount image', 'invoicing' ),
-						'remove_featured_image' => __( 'Remove discount image', 'invoicing' ),
-						'use_featured_image'    => __( 'Use as discount image', 'invoicing' ),
-						'insert_into_item'      => __( 'Insert into discount', 'invoicing' ),
-						'uploaded_to_this_item' => __( 'Uploaded to this discount', 'invoicing' ),
-						'filter_items_list'     => __( 'Filter discounts', 'invoicing' ),
-						'items_list_navigation' => __( 'Discount navigation', 'invoicing' ),
-						'items_list'            => __( 'Discounts list', 'invoicing' ),
-					),
-					'description'        => __( 'This is where you can add new discounts that users can use in invoices.', 'invoicing' ),
-					'public'             => false,
-					'can_export'         => true,
-					'_builtin'           => false,
-					'publicly_queryable' => false,
-					'exclude_from_search'=> true,
-					'show_ui'            => true,
-					'show_in_menu'       => wpinv_current_user_can_manage_invoicing() ? 'wpinv' : false,
-					'query_var'          => false,
-					'rewrite'            => false,
-					'map_meta_cap'       => true,
-					'has_archive'        => false,
-					'hierarchical'       => false,
-					'supports'           => array( 'title', 'excerpt' ),
-					'show_in_nav_menus'  => false,
-					'show_in_admin_bar'  => true,
-					'menu_position'      => null,
-				)
-			)
-		);
+        // Register discount post type.
+        register_post_type(
+            'wpi_discount',
+            apply_filters(
+                'wpinv_register_post_type_discount',
+                array(
+                    'labels'                 => array(
+                        'name'                  => __( 'Discounts', 'invoicing' ),
+                        'singular_name'         => __( 'Discount', 'invoicing' ),
+                        'all_items'             => __( 'Discounts', 'invoicing' ),
+                        'menu_name'             => _x( 'Discounts', 'Admin menu name', 'invoicing' ),
+                        'add_new'               => __( 'Add New', 'invoicing' ),
+                        'add_new_item'          => __( 'Add new discount', 'invoicing' ),
+                        'edit'                  => __( 'Edit', 'invoicing' ),
+                        'edit_item'             => __( 'Edit discount', 'invoicing' ),
+                        'new_item'              => __( 'New discount', 'invoicing' ),
+                        'view_item'             => __( 'View discount', 'invoicing' ),
+                        'view_items'            => __( 'View Discounts', 'invoicing' ),
+                        'search_items'          => __( 'Search discounts', 'invoicing' ),
+                        'not_found'             => __( 'No discounts found', 'invoicing' ),
+                        'not_found_in_trash'    => __( 'No discounts found in trash', 'invoicing' ),
+                        'parent'                => __( 'Parent discount', 'invoicing' ),
+                        'featured_image'        => __( 'Discount image', 'invoicing' ),
+                        'set_featured_image'    => __( 'Set discount image', 'invoicing' ),
+                        'remove_featured_image' => __( 'Remove discount image', 'invoicing' ),
+                        'use_featured_image'    => __( 'Use as discount image', 'invoicing' ),
+                        'insert_into_item'      => __( 'Insert into discount', 'invoicing' ),
+                        'uploaded_to_this_item' => __( 'Uploaded to this discount', 'invoicing' ),
+                        'filter_items_list'     => __( 'Filter discounts', 'invoicing' ),
+                        'items_list_navigation' => __( 'Discount navigation', 'invoicing' ),
+                        'items_list'            => __( 'Discounts list', 'invoicing' ),
+                    ),
+                    'description'        => __( 'This is where you can add new discounts that users can use in invoices.', 'invoicing' ),
+                    'public'             => false,
+                    'can_export'         => true,
+                    '_builtin'           => false,
+                    'publicly_queryable' => false,
+                    'exclude_from_search'=> true,
+                    'show_ui'            => true,
+                    'show_in_menu'       => wpinv_current_user_can_manage_invoicing() ? 'wpinv' : false,
+                    'query_var'          => false,
+                    'rewrite'            => false,
+                    'map_meta_cap'       => true,
+                    'has_archive'        => false,
+                    'hierarchical'       => false,
+                    'supports'           => array( 'title', 'excerpt' ),
+                    'show_in_nav_menus'  => false,
+                    'show_in_admin_bar'  => true,
+                    'menu_position'      => null,
+                )
+            )
+        );
 
-		do_action( 'getpaid_after_register_post_types' );
-	}
+        do_action( 'getpaid_after_register_post_types' );
+    }
 
-	/**
-	 * Register our custom post statuses.
-	 */
-	public static function register_post_status() {
+    /**
+     * Register our custom post statuses.
+     */
+    public static function register_post_status() {
 
-		$invoice_statuses = apply_filters(
-			'getpaid_register_invoice_post_statuses',
-			array(
+        $invoice_statuses = apply_filters(
+            'getpaid_register_invoice_post_statuses',
+            array(
 
-				'wpi-pending' => array(
-					'label'                     => _x( 'Pending Payment', 'Invoice status', 'invoicing' ),
-        			'public'                    => true,
-        			'exclude_from_search'       => true,
-        			'show_in_admin_all_list'    => true,
-					'show_in_admin_status_list' => true,
-					/* translators: %s: number of invoices */
-        			'label_count'               => _n_noop( 'Pending Payment <span class="count">(%s)</span>', 'Pending Payment <span class="count">(%s)</span>', 'invoicing' )
-				),
+                'wpi-pending' => array(
+                    'label'                     => _x( 'Pending Payment', 'Invoice status', 'invoicing' ),
+                    'public'                    => true,
+                    'exclude_from_search'       => true,
+                    'show_in_admin_all_list'    => true,
+                    'show_in_admin_status_list' => true,
+                    /* translators: %s: number of invoices */
+                    'label_count'               => _n_noop( 'Pending Payment <span class="count">(%s)</span>', 'Pending Payment <span class="count">(%s)</span>', 'invoicing' )
+                ),
 
-				'wpi-processing' => array(
-					'label'                     => _x( 'Processing', 'Invoice status', 'invoicing' ),
-        			'public'                    => true,
-        			'exclude_from_search'       => true,
-        			'show_in_admin_all_list'    => true,
-					'show_in_admin_status_list' => true,
-					/* translators: %s: number of invoices */
-        			'label_count'               => _n_noop( 'Processing <span class="count">(%s)</span>', 'Processing <span class="count">(%s)</span>', 'invoicing' )
-				),
+                'wpi-processing' => array(
+                    'label'                     => _x( 'Processing', 'Invoice status', 'invoicing' ),
+                    'public'                    => true,
+                    'exclude_from_search'       => true,
+                    'show_in_admin_all_list'    => true,
+                    'show_in_admin_status_list' => true,
+                    /* translators: %s: number of invoices */
+                    'label_count'               => _n_noop( 'Processing <span class="count">(%s)</span>', 'Processing <span class="count">(%s)</span>', 'invoicing' )
+                ),
 
-				'wpi-onhold' => array(
-					'label'                     => _x( 'On Hold', 'Invoice status', 'invoicing' ),
-        			'public'                    => true,
-        			'exclude_from_search'       => true,
-        			'show_in_admin_all_list'    => true,
-					'show_in_admin_status_list' => true,
-					/* translators: %s: number of invoices */
-        			'label_count'               => _n_noop( 'On Hold <span class="count">(%s)</span>', 'On Hold <span class="count">(%s)</span>', 'invoicing' )
-				),
+                'wpi-onhold' => array(
+                    'label'                     => _x( 'On Hold', 'Invoice status', 'invoicing' ),
+                    'public'                    => true,
+                    'exclude_from_search'       => true,
+                    'show_in_admin_all_list'    => true,
+                    'show_in_admin_status_list' => true,
+                    /* translators: %s: number of invoices */
+                    'label_count'               => _n_noop( 'On Hold <span class="count">(%s)</span>', 'On Hold <span class="count">(%s)</span>', 'invoicing' )
+                ),
 
-				'wpi-cancelled' => array(
-					'label'                     => _x( 'Cancelled', 'Invoice status', 'invoicing' ),
-        			'public'                    => true,
-        			'exclude_from_search'       => true,
-        			'show_in_admin_all_list'    => true,
-					'show_in_admin_status_list' => true,
-					/* translators: %s: number of invoices */
-        			'label_count'               => _n_noop( 'Cancelled <span class="count">(%s)</span>', 'Cancelled <span class="count">(%s)</span>', 'invoicing' )
-				),
+                'wpi-cancelled' => array(
+                    'label'                     => _x( 'Cancelled', 'Invoice status', 'invoicing' ),
+                    'public'                    => true,
+                    'exclude_from_search'       => true,
+                    'show_in_admin_all_list'    => true,
+                    'show_in_admin_status_list' => true,
+                    /* translators: %s: number of invoices */
+                    'label_count'               => _n_noop( 'Cancelled <span class="count">(%s)</span>', 'Cancelled <span class="count">(%s)</span>', 'invoicing' )
+                ),
 
-				'wpi-refunded' => array(
-					'label'                     => _x( 'Refunded', 'Invoice status', 'invoicing' ),
-        			'public'                    => true,
-        			'exclude_from_search'       => true,
-        			'show_in_admin_all_list'    => true,
-					'show_in_admin_status_list' => true,
-					/* translators: %s: number of invoices */
-        			'label_count'               => _n_noop( 'Refunded <span class="count">(%s)</span>', 'Refunded <span class="count">(%s)</span>', 'invoicing' )
-				),
+                'wpi-refunded' => array(
+                    'label'                     => _x( 'Refunded', 'Invoice status', 'invoicing' ),
+                    'public'                    => true,
+                    'exclude_from_search'       => true,
+                    'show_in_admin_all_list'    => true,
+                    'show_in_admin_status_list' => true,
+                    /* translators: %s: number of invoices */
+                    'label_count'               => _n_noop( 'Refunded <span class="count">(%s)</span>', 'Refunded <span class="count">(%s)</span>', 'invoicing' )
+                ),
 
-				'wpi-failed' => array(
-					'label'                     => _x( 'Failed', 'Invoice status', 'invoicing' ),
-        			'public'                    => true,
-        			'exclude_from_search'       => true,
-        			'show_in_admin_all_list'    => true,
-					'show_in_admin_status_list' => true,
-					/* translators: %s: number of invoices */
-        			'label_count'               => _n_noop( 'Failed <span class="count">(%s)</span>', 'Failed <span class="count">(%s)</span>', 'invoicing' )
-				),
+                'wpi-failed' => array(
+                    'label'                     => _x( 'Failed', 'Invoice status', 'invoicing' ),
+                    'public'                    => true,
+                    'exclude_from_search'       => true,
+                    'show_in_admin_all_list'    => true,
+                    'show_in_admin_status_list' => true,
+                    /* translators: %s: number of invoices */
+                    'label_count'               => _n_noop( 'Failed <span class="count">(%s)</span>', 'Failed <span class="count">(%s)</span>', 'invoicing' )
+                ),
 
-				'wpi-renewal' => array(
-					'label'                     => _x( 'Renewal', 'Invoice status', 'invoicing' ),
-        			'public'                    => true,
-        			'exclude_from_search'       => true,
-        			'show_in_admin_all_list'    => true,
-					'show_in_admin_status_list' => true,
-					/* translators: %s: number of invoices */
-        			'label_count'               => _n_noop( 'Renewal <span class="count">(%s)</span>', 'Renewal <span class="count">(%s)</span>', 'invoicing' )
-				)
-			)
-		);
+                'wpi-renewal' => array(
+                    'label'                     => _x( 'Renewal', 'Invoice status', 'invoicing' ),
+                    'public'                    => true,
+                    'exclude_from_search'       => true,
+                    'show_in_admin_all_list'    => true,
+                    'show_in_admin_status_list' => true,
+                    /* translators: %s: number of invoices */
+                    'label_count'               => _n_noop( 'Renewal <span class="count">(%s)</span>', 'Renewal <span class="count">(%s)</span>', 'invoicing' )
+                )
+            )
+        );
 
-		foreach ( $invoice_statuses as $invoice_statuse => $args ) {
-			register_post_status( $invoice_statuse, $args );
-		}
-	}
+        foreach ( $invoice_statuses as $invoice_statuse => $args ) {
+            register_post_status( $invoice_statuse, $args );
+        }
+    }
 
-	/**
-	 * Flush rewrite rules.
-	 */
-	public static function flush_rewrite_rules() {
-		flush_rewrite_rules();
-	}
+    /**
+     * Flush rewrite rules.
+     */
+    public static function flush_rewrite_rules() {
+        flush_rewrite_rules();
+    }
 
-	/**
-	 * Flush rules to prevent 404.
-	 *
-	 */
-	public static function maybe_flush_rewrite_rules() {
-		if ( ! get_option( 'getpaid_flushed_rewrite_rules' ) ) {
-			update_option( 'getpaid_flushed_rewrite_rules', '1' );
-			self::flush_rewrite_rules();
-		}
-	}
+    /**
+     * Flush rules to prevent 404.
+     *
+     */
+    public static function maybe_flush_rewrite_rules() {
+        if ( ! get_option( 'getpaid_flushed_rewrite_rules' ) ) {
+            update_option( 'getpaid_flushed_rewrite_rules', '1' );
+            self::flush_rewrite_rules();
+        }
+    }
 
 }

includes/gateways/class-getpaid-manual-gateway.php

Indentation +38 added lines, -38 removed lines

@@ -13,30 +13,30 @@ 
 class GetPaid_Manual_Gateway extends GetPaid_Payment_Gateway {
 
     /**
-	 * Payment method id.
-	 *
-	 * @var string
-	 */
+     * Payment method id.
+     *
+     * @var string
+     */
     public $id = 'manual';
 
     /**
-	 * An array of features that this gateway supports.
-	 *
-	 * @var array
-	 */
+     * An array of features that this gateway supports.
+     *
+     * @var array
+     */
     protected $supports = array( 'subscription', 'addons' );
 
     /**
-	 * Payment method order.
-	 *
-	 * @var int
-	 */
-	public $order = 11;
+     * Payment method order.
+     *
+     * @var int
+     */
+    public $order = 11;
 
     /**
-	 * Class constructor.
-	 */
-	public function __construct() {
+     * Class constructor.
+     */
+    public function __construct() {
         parent::__construct();
 
         $this->title        = __( 'Test Gateway', 'invoicing' );
@@ -46,15 +46,15 @@ 
     }
 
     /**
-	 * Process Payment.
-	 *
-	 *
-	 * @param WPInv_Invoice $invoice Invoice.
-	 * @param array $submission_data Posted checkout fields.
-	 * @param GetPaid_Payment_Form_Submission $submission Checkout submission.
-	 * @return array
-	 */
-	public function process_payment( $invoice, $submission_data, $submission ) {
+     * Process Payment.
+     *
+     *
+     * @param WPInv_Invoice $invoice Invoice.
+     * @param array $submission_data Posted checkout fields.
+     * @param GetPaid_Payment_Form_Submission $submission Checkout submission.
+     * @return array
+     */
+    public function process_payment( $invoice, $submission_data, $submission ) {
 
         // Mark it as paid.
         $invoice->mark_paid();
@@ -68,13 +68,13 @@ 
     }
 
     /**
-	 * (Maybe) renews a manual subscription profile.
-	 *
-	 *
-	 * @param bool $should_expire
+     * (Maybe) renews a manual subscription profile.
+     *
+     *
+     * @param bool $should_expire
      * @param WPInv_Subscription $subscription
-	 */
-	public function maybe_renew_subscription( $should_expire, $subscription ) {
+     */
+    public function maybe_renew_subscription( $should_expire, $subscription ) {
 
         // Ensure its our subscription && it's active.
         if ( 'manual' != $subscription->get_gateway() || ! $subscription->has_status( 'active trialling' ) ) {
@@ -102,13 +102,13 @@ 
     }
 
     /**
-	 * Processes invoice addons.
-	 *
-	 * @param WPInv_Invoice $invoice
-	 * @param GetPaid_Form_Item[] $items
-	 * @return WPInv_Invoice
-	 */
-	public function process_addons( $invoice, $items ) {
+     * Processes invoice addons.
+     *
+     * @param WPInv_Invoice $invoice
+     * @param GetPaid_Form_Item[] $items
+     * @return WPInv_Invoice
+     */
+    public function process_addons( $invoice, $items ) {
 
         foreach ( $items as $item ) {
             $invoice->add_item( $item );

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'] );
+
+    }
 
 }

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);
 
-	}
+    }
 }

templates/subscriptions/subscription-details.php

Indentation +52 added lines, -52 removed lines

@@ -43,64 +43,64 @@ 
 				<td class="w-75">
 					<?php
 
-						switch ( $key ) {
+                        switch ( $key ) {
 
-							case 'status':
-								echo sanitize_text_field( $subscription->get_status_label() );
-								break;
+                            case 'status':
+                                echo sanitize_text_field( $subscription->get_status_label() );
+                                break;
 
-							case 'start_date':
-								echo sanitize_text_field( getpaid_format_date_value( $subscription->get_date_created() ) );
-								break;
+                            case 'start_date':
+                                echo sanitize_text_field( getpaid_format_date_value( $subscription->get_date_created() ) );
+                                break;
 
-							case 'expiry_date':
-								echo sanitize_text_field( getpaid_format_date_value( $subscription->get_next_renewal_date() ) );
-								break;
+                            case 'expiry_date':
+                                echo sanitize_text_field( getpaid_format_date_value( $subscription->get_next_renewal_date() ) );
+                                break;
 
-							case 'initial_amount':
-								echo wpinv_price( $subscription->get_initial_amount(), $subscription->get_parent_payment()->get_currency() );
+                            case 'initial_amount':
+                                echo wpinv_price( $subscription->get_initial_amount(), $subscription->get_parent_payment()->get_currency() );
 
-								if ( $subscription->has_trial_period() ) {
+                                if ( $subscription->has_trial_period() ) {
 
-									echo "<small class='text-muted'>&nbsp;";
-									printf(
-										_x( '( %1$s trial )', 'Subscription trial period. (e.g.: 1 month trial)', 'invoicing' ),
-										sanitize_text_field( $subscription->get_trial_period() )
-									);
-									echo '</small>';
+                                    echo "<small class='text-muted'>&nbsp;";
+                                    printf(
+                                        _x( '( %1$s trial )', 'Subscription trial period. (e.g.: 1 month trial)', 'invoicing' ),
+                                        sanitize_text_field( $subscription->get_trial_period() )
+                                    );
+                                    echo '</small>';
 
-								}
+                                }
 								
-								break;
+                                break;
 
-							case 'recurring_amount':
-								$frequency = getpaid_get_subscription_period_label( $subscription->get_period(), $subscription->get_frequency(), '' );
-								$amount    = wpinv_price( $subscription->get_recurring_amount(), $subscription->get_parent_payment()->get_currency() );
-								echo strtolower( "<strong style='font-weight: 500;'>$amount</strong> / <span class='getpaid-item-recurring-period'>$frequency</span>" );
-								break;
+                            case 'recurring_amount':
+                                $frequency = getpaid_get_subscription_period_label( $subscription->get_period(), $subscription->get_frequency(), '' );
+                                $amount    = wpinv_price( $subscription->get_recurring_amount(), $subscription->get_parent_payment()->get_currency() );
+                                echo strtolower( "<strong style='font-weight: 500;'>$amount</strong> / <span class='getpaid-item-recurring-period'>$frequency</span>" );
+                                break;
 
-							case 'item':
-								$item = get_post( $subscription->get_product_id() );
+                            case 'item':
+                                $item = get_post( $subscription->get_product_id() );
 
-								if ( ! empty( $item ) ) {
-									echo esc_html( get_the_title( $item ) );
-								} else {
-									echo sprintf( __( 'Item #%s', 'invoicing' ), $subscription->get_product_id() );
-								}
+                                if ( ! empty( $item ) ) {
+                                    echo esc_html( get_the_title( $item ) );
+                                } else {
+                                    echo sprintf( __( 'Item #%s', 'invoicing' ), $subscription->get_product_id() );
+                                }
 
-								break;
+                                break;
 
-							case 'payments':
+                            case 'payments':
 
-								$max_activations = (int) $subscription->get_bill_times();
-								echo (int) $subscription->get_times_billed() . ' / ' . ( empty( $max_activations ) ? "&infin;" : $max_activations );
+                                $max_activations = (int) $subscription->get_bill_times();
+                                echo (int) $subscription->get_times_billed() . ' / ' . ( empty( $max_activations ) ? "&infin;" : $max_activations );
 
-								break;
+                                break;
 
-						}
-						do_action( "getpaid_render_single_subscription_column_$key", $subscription );
+                        }
+                        do_action( "getpaid_render_single_subscription_column_$key", $subscription );
 
-					?>
+                    ?>
 				</td>
 
 			</tr>
@@ -117,17 +117,17 @@ 
 <span class="form-text">
 
 	<?php
-		if ( $subscription->can_cancel() ) {
-			printf(
-				'<a href="%s" class="btn btn-danger btn-sm" onclick="return confirm(\'%s\')">%s</a>&nbsp;&nbsp;',
-				esc_url( $subscription->get_cancel_url() ),
-				esc_attr__( 'Are you sure you want to cancel this subscription?', 'invoicing' ),
-				__( 'Cancel Subscription', 'invoicing' )
-			);
-		}
-
-		do_action( 'getpaid-single-subscription-page-actions', $subscription );
-	?>
+        if ( $subscription->can_cancel() ) {
+            printf(
+                '<a href="%s" class="btn btn-danger btn-sm" onclick="return confirm(\'%s\')">%s</a>&nbsp;&nbsp;',
+                esc_url( $subscription->get_cancel_url() ),
+                esc_attr__( 'Are you sure you want to cancel this subscription?', 'invoicing' ),
+                __( 'Cancel Subscription', 'invoicing' )
+            );
+        }
+
+        do_action( 'getpaid-single-subscription-page-actions', $subscription );
+    ?>
 
 	<a href="<?php echo esc_url( getpaid_get_tab_url( 'gp-subscriptions', get_permalink( (int) wpinv_get_option( 'invoice_subscription_page' ) ) ) ); ?>" class="btn btn-secondary btn-sm"><?php _e( 'Go Back', 'invoicing' ); ?></a>
 </span>
\ No newline at end of file

templates/subscriptions/subscriptions-table-row.php

Indentation +28 added lines, -28 removed lines

@@ -13,42 +13,42 @@
 
 foreach ( array_keys( $widget->get_subscriptions_table_columns() ) as $column ) :
 
-	$class = sanitize_html_class( $column );
-	echo "<td class='getpaid-subscriptions-table-column-$class'>";
+    $class = sanitize_html_class( $column );
+    echo "<td class='getpaid-subscriptions-table-column-$class'>";
 
-		do_action( "getpaid_subscriptions_before_frontend_subscription_table_$column", $subscription );
+        do_action( "getpaid_subscriptions_before_frontend_subscription_table_$column", $subscription );
 
-		switch( $column ) :
+        switch( $column ) :
 
-			case 'subscription':
-				$subscription_id = (int) $subscription->get_id();
-				$url             = esc_url( $subscription->get_view_url() );
-				$id_label        = sprintf(
-					esc_attr_x( '#%s', 'subscription id', 'invoicing' ),
-					$subscription->get_id()
-				);
-				echo $widget->add_row_actions( "<a href='$url' class='font-weight-bold text-decoration-none'>$id_label</a>", $subscription );
-				break;
+            case 'subscription':
+                $subscription_id = (int) $subscription->get_id();
+                $url             = esc_url( $subscription->get_view_url() );
+                $id_label        = sprintf(
+                    esc_attr_x( '#%s', 'subscription id', 'invoicing' ),
+                    $subscription->get_id()
+                );
+                echo $widget->add_row_actions( "<a href='$url' class='font-weight-bold text-decoration-none'>$id_label</a>", $subscription );
+                break;
 
-			case 'status':
-				echo sanitize_text_field( $subscription->get_status_label() );
-				break;
+            case 'status':
+                echo sanitize_text_field( $subscription->get_status_label() );
+                break;
 
-			case 'renewal-date':
-				$renewal = getpaid_format_date_value( $subscription->get_next_renewal_date() );
-				echo $subscription->is_active() ? sanitize_text_field( $renewal ) : "&mdash;";
-				break;
+            case 'renewal-date':
+                $renewal = getpaid_format_date_value( $subscription->get_next_renewal_date() );
+                echo $subscription->is_active() ? sanitize_text_field( $renewal ) : "&mdash;";
+                break;
 
-			case 'amount':
-				$frequency = getpaid_get_subscription_period_label( $subscription->get_period(), $subscription->get_frequency(), '' );
-				$amount    = wpinv_price( $subscription->get_recurring_amount(), $subscription->get_parent_payment()->get_currency() );
-				echo wp_kses_post( "<span>$amount</span> / <span class='getpaid-item-recurring-period'>$frequency</span>" );
-				break;
+            case 'amount':
+                $frequency = getpaid_get_subscription_period_label( $subscription->get_period(), $subscription->get_frequency(), '' );
+                $amount    = wpinv_price( $subscription->get_recurring_amount(), $subscription->get_parent_payment()->get_currency() );
+                echo wp_kses_post( "<span>$amount</span> / <span class='getpaid-item-recurring-period'>$frequency</span>" );
+                break;
 
-		endswitch;
+        endswitch;
 
-		do_action( "getpaid_subscriptions_frontend_subscription_table_$column", $subscription );
+        do_action( "getpaid_subscriptions_frontend_subscription_table_$column", $subscription );
 
-	echo '</td>';
+    echo '</td>';
 
 endforeach;