AyeCode / invoicing

includes/class-getpaid-customers-query.php

Indentation +497 added lines, -497 removed lines

@@ -16,502 +16,502 @@
  */
 class GetPaid_Customers_Query {
 
-	/**
-	 * Query vars, after parsing
-	 *
-	 * @since 1.0.19
-	 * @var array
-	 */
-	public $query_vars = array();
-
-	/**
-	 * List of found customers.
-	 *
-	 * @since 1.0.19
-	 * @var array
-	 */
-	private $results;
-
-	/**
-	 * Total number of found customers for the current query
-	 *
-	 * @since 1.0.19
-	 * @var int
-	 */
-	private $total_customers = 0;
-
-	/**
-	 * The SQL query used to fetch matching customers.
-	 *
-	 * @since 1.0.19
-	 * @var string
-	 */
-	public $request;
-
-	// SQL clauses
-
-	/**
-	 * Contains the 'FIELDS' sql clause
-	 *
-	 * @since 1.0.19
-	 * @var string
-	 */
-	public $query_fields;
-
-	/**
-	 * Contains the 'FROM' sql clause
-	 *
-	 * @since 1.0.19
-	 * @var string
-	 */
-	public $query_from;
-
-	/**
-	 * Contains the 'WHERE' sql clause
-	 *
-	 * @since 1.0.19
-	 * @var string
-	 */
-	public $query_where;
-
-	/**
-	 * Contains the 'ORDER BY' sql clause
-	 *
-	 * @since 1.0.19
-	 * @var string
-	 */
-	public $query_orderby;
-
-	/**
-	 * Contains the 'LIMIT' sql clause
-	 *
-	 * @since 1.0.19
-	 * @var string
-	 */
-	public $query_limit;
-
-	/**
-	 * Class constructor.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @param null|string|array $query Optional. The query variables.
-	 */
-	public function __construct( $query = null ) {
-		if ( ! is_null( $query ) ) {
-			$this->prepare_query( $query );
-			$this->query();
-		}
-	}
-
-	/**
-	 * Fills in missing query variables with default values.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @param  string|array $args Query vars, as passed to `GetPaid_Subscriptions_Query`.
-	 * @return array Complete query variables with undefined ones filled in with defaults.
-	 */
-	public static function fill_query_vars( $args ) {
-		$defaults = array(
-			'include'     => array(),
-			'exclude'     => array(),
-			'orderby'     => 'id',
-			'order'       => 'DESC',
-			'offset'      => '',
-			'number'      => 10,
-			'paged'       => 1,
-			'count_total' => true,
-			'fields'      => 'all',
-			's'           => '',
-		);
-
-		foreach ( GetPaid_Customer_Data_Store::get_database_fields() as $field => $type ) {
-			$defaults[ $field ] = 'any';
-
-			if ( '%f' === $type || '%d' === $type ) {
-				$defaults[ $field . '_min' ] = '';
-				$defaults[ $field . '_max' ] = '';
-			}
-		}
-
-		return wp_parse_args( $args, $defaults );
-	}
-
-	/**
-	 * Prepare the query variables.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @see self::fill_query_vars() For allowede args and their defaults.
-	 */
-	public function prepare_query( $query = array() ) {
-		global $wpdb;
-
-		if ( empty( $this->query_vars ) || ! empty( $query ) ) {
-			$this->query_limit = null;
-			$this->query_vars  = $this->fill_query_vars( $query );
-		}
-
-		if ( ! empty( $this->query_vars['fields'] ) && 'all' !== $this->query_vars['fields'] ) {
-			$this->query_vars['fields'] = wpinv_parse_list( $this->query_vars['fields'] );
-		}
-
-		do_action( 'getpaid_pre_get_customers', array( &$this ) );
-
-		// Ensure that query vars are filled after 'getpaid_pre_get_customers'.
-		$qv                = & $this->query_vars;
-		$qv                = $this->fill_query_vars( $qv );
-		$table             = $wpdb->prefix . 'getpaid_customers';
-		$this->query_from  = "FROM $table";
-
-		// Prepare query fields.
-		$this->prepare_query_fields( $qv, $table );
-
-		// Prepare query where.
-		$this->prepare_query_where( $qv, $table );
-
-		// Prepare query order.
-		$this->prepare_query_order( $qv, $table );
-
-		// limit
-		if ( isset( $qv['number'] ) && $qv['number'] > 0 ) {
-			if ( $qv['offset'] ) {
-				$this->query_limit = $wpdb->prepare( 'LIMIT %d, %d', $qv['offset'], $qv['number'] );
-			} else {
-				$this->query_limit = $wpdb->prepare( 'LIMIT %d, %d', $qv['number'] * ( $qv['paged'] - 1 ), $qv['number'] );
-			}
-		}
-
-		do_action_ref_array( 'getpaid_after_customers_query', array( &$this ) );
-	}
-
-	/**
-	 * Prepares the query fields.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @param array $qv Query vars.
-	 * @param string $table Table name.
-	 */
-	protected function prepare_query_fields( &$qv, $table ) {
-
-		if ( is_array( $qv['fields'] ) ) {
-			$qv['fields']   = array_unique( $qv['fields'] );
-			$allowed_fields = array_keys( GetPaid_Customer_Data_Store::get_database_fields() );
-
-			$query_fields = array();
-			foreach ( $qv['fields'] as $field ) {
-				if ( ! in_array( $field, $allowed_fields ) ) {
-					continue;
-				}
-
-				$field          = sanitize_key( $field );
-				$query_fields[] = "$table.`$field`";
-			}
-			$this->query_fields = implode( ',', $query_fields );
-		} else {
-			$this->query_fields = "$table.*";
-		}
-
-		if ( isset( $qv['count_total'] ) && $qv['count_total'] ) {
-			$this->query_fields = 'SQL_CALC_FOUND_ROWS ' . $this->query_fields;
-		}
-
-	}
-
-	/**
-	 * Prepares the query where.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @param array $qv Query vars.
-	 * @param string $table Table name.
-	 */
-	protected function prepare_query_where( &$qv, $table ) {
-		global $wpdb;
-		$this->query_where = 'WHERE 1=1';
-
-		// Fields.
-		foreach ( GetPaid_Customer_Data_Store::get_database_fields() as $field => $type ) {
-			if ( 'any' !== $qv[ $field ] ) {
-
-				// In.
-				if ( is_array( $qv[ $field ] ) ) {
-					$in                 = join( ',', array_fill( 0, count( $qv[ $field ] ), $type ) );
-					$this->query_where .= $wpdb->prepare( " AND $table.`status` IN ( $in )", $qv[ $field ] );
-				} elseif ( ! empty( $qv[ $field ] ) ) {
-					$this->query_where .= $wpdb->prepare( " AND $table.`$field` = $type", $qv[ $field ] );
-				}
-			}
-
-			// Min/Max.
-			if ( '%f' === $type || '%d' === $type ) {
-
-				// Min.
-				if ( is_numeric( $qv[ $field . '_min' ] ) ) {
-					$this->query_where .= $wpdb->prepare( " AND $table.`$field` >= $type", $qv[ $field . '_min' ] );
-				}
-
-				// Max.
-				if ( is_numeric( $qv[ $field . '_max' ] ) ) {
-					$this->query_where .= $wpdb->prepare( " AND $table.`$field` <= $type", $qv[ $field . '_max' ] );
-				}
-			}
-		}
-
-		if ( ! empty( $qv['include'] ) ) {
-			$include            = implode( ',', wp_parse_id_list( $qv['include'] ) );
-			$this->query_where .= " AND $table.`id` IN ($include)";
-		} elseif ( ! empty( $qv['exclude'] ) ) {
-			$exclude            = implode( ',', wp_parse_id_list( $qv['exclude'] ) );
-			$this->query_where .= " AND $table.`id` NOT IN ($exclude)";
-		}
-
-		// Date queries are allowed for the customer creation date.
-		if ( ! empty( $qv['date_created_query'] ) && is_array( $qv['date_created_query'] ) ) {
-			$date_created_query = new WP_Date_Query( $qv['date_created_query'], "$table.date_created" );
-			$this->query_where .= $date_created_query->get_sql();
-		}
-
-		// Search.
-		if ( ! empty( $qv['s'] ) ) {
-			$this->query_where .= $this->get_search_sql( $qv['s'] );
-		}
-	}
-
-	/**
-	 * Used internally to generate an SQL string for searching across multiple columns
-	 *
-	 * @since 1.2.7
-	 *
-	 * @global wpdb $wpdb WordPress database abstraction object.
-	 *
-	 * @param string $string The string to search for.
-	 * @return string
-	 */
-	protected function get_search_sql( $string ) {
-		global $wpdb;
-
-		$searches = array();
-		$string   = trim( $string, '%' );
-		$like     = '%' . $wpdb->esc_like( $string ) . '%';
-
-		foreach ( array_keys( GetPaid_Customer_Data_Store::get_database_fields() ) as $col ) {
-			if ( 'id' === $col || 'user_id' === $col ) {
-				$searches[] = $wpdb->prepare( "$col = %s", $string );  // phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared
-			} else {
-				$searches[] = $wpdb->prepare( "$col LIKE %s", $like );  // phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared
-			}
-		}
-
-		return ' AND (' . implode( ' OR ', $searches ) . ')';
-	}
-
-	/**
-	 * Prepares the query order.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @param array $qv Query vars.
-	 * @param string $table Table name.
-	 */
-	protected function prepare_query_order( &$qv, $table ) {
-
-		// sorting.
-		$qv['order'] = isset( $qv['order'] ) ? strtoupper( $qv['order'] ) : '';
-		$order       = $this->parse_order( $qv['order'] );
-
-		// Default order is by 'id' (latest customers).
-		if ( empty( $qv['orderby'] ) ) {
-			$qv['orderby'] = array( 'id' );
-		}
-
-		// 'orderby' values may be an array, comma- or space-separated list.
-		$ordersby      = array_filter( wpinv_parse_list( $qv['orderby'] ) );
-
-		$orderby_array = array();
-		foreach ( $ordersby as $_key => $_value ) {
-
-			if ( is_int( $_key ) ) {
-				// Integer key means this is a flat array of 'orderby' fields.
-				$_orderby = $_value;
-				$_order   = $order;
-			} else {
-				// Non-integer key means that the key is the field and the value is ASC/DESC.
-				$_orderby = $_key;
-				$_order   = $_value;
-			}
-
-			$parsed = $this->parse_orderby( $_orderby, $table );
-
-			if ( $parsed ) {
-				$orderby_array[] = $parsed . ' ' . $this->parse_order( $_order );
-			}
-		}
-
-		// If no valid clauses were found, order by id.
-		if ( empty( $orderby_array ) ) {
-			$orderby_array[] = "id $order";
-		}
-
-		$this->query_orderby = 'ORDER BY ' . implode( ', ', $orderby_array );
-
-	}
-
-	/**
-	 * Execute the query, with the current variables.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @global wpdb $wpdb WordPress database abstraction object.
-	 */
-	public function query() {
-		global $wpdb;
-
-		$qv =& $this->query_vars;
-
-		// Return a non-null value to bypass the default GetPaid customers query and remember to set the
-		// total_customers property.
-		$this->results = apply_filters_ref_array( 'getpaid_customers_pre_query', array( null, &$this ) );
-
-		if ( null === $this->results ) {
-			$this->request = "SELECT $this->query_fields $this->query_from $this->query_where $this->query_orderby $this->query_limit";
-
-			if ( ( is_array( $qv['fields'] ) && 1 !== count( $qv['fields'] ) ) || 'all' === $qv['fields'] ) {
-				$this->results = $wpdb->get_results( $this->request );
-			} else {
-				$this->results = $wpdb->get_col( $this->request );
-			}
-
-			if ( isset( $qv['count_total'] ) && $qv['count_total'] ) {
-				$found_customers_query = apply_filters( 'getpaid_found_customers_query', 'SELECT FOUND_ROWS()', $this );
-				$this->total_customers = (int) $wpdb->get_var( $found_customers_query );
-			}
-		}
-
-		if ( 'all' === $qv['fields'] ) {
-			foreach ( $this->results as $key => $customer ) {
-				$this->set_cache( $customer->id, $customer, 'getpaid_customers' );
-				$this->set_cache( $customer->user_id, $customer->id, 'getpaid_customer_ids_by_user_id' );
-				$this->set_cache( $customer->email, $customer->id, 'getpaid_customer_ids_by_email' );
-				$this->results[ $key ] = new GetPaid_Customer( $customer );
-			}
-		}
-
-	}
-
-	/**
-	 * Set cache
-	 *
-	 * @param string  $id
-	 * @param mixed   $data
-	 * @param string  $group
-	 * @param integer $expire
-	 * @return boolean
-	 */
-	public function set_cache( $key, $data, $group = '', $expire = 0 ) {
-
-		if ( empty( $key ) ) {
-			return false;
-		}
-
-		wp_cache_set( $key, $data, $group, $expire );
-	}
-
-	/**
-	 * Retrieve query variable.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @param string $query_var Query variable key.
-	 * @return mixed
-	 */
-	public function get( $query_var ) {
-		if ( isset( $this->query_vars[ $query_var ] ) ) {
-			return $this->query_vars[ $query_var ];
-		}
-
-		return null;
-	}
-
-	/**
-	 * Set query variable.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @param string $query_var Query variable key.
-	 * @param mixed $value Query variable value.
-	 */
-	public function set( $query_var, $value ) {
-		$this->query_vars[ $query_var ] = $value;
-	}
-
-	/**
-	 * Return the list of customers.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @return GetPaid_Customer[]|array Found customers.
-	 */
-	public function get_results() {
-		return $this->results;
-	}
-
-	/**
-	 * Return the total number of customers for the current query.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @return int Number of total customers.
-	 */
-	public function get_total() {
-		return $this->total_customers;
-	}
-
-	/**
-	 * Parse and sanitize 'orderby' keys passed to the customers query.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @param string $orderby Alias for the field to order by.
-	 *  @param string $table The current table.
-	 * @return string Value to use in the ORDER clause, if `$orderby` is valid.
-	 */
-	protected function parse_orderby( $orderby, $table ) {
-
-		$_orderby = '';
-		if ( in_array( $orderby, array_keys( GetPaid_Customer_Data_Store::get_database_fields() ), true ) ) {
-			$_orderby = "$table.`$orderby`";
-		} elseif ( 'id' === strtolower( $orderby ) ) {
-			$_orderby = "$table.id";
-		} elseif ( 'include' === $orderby && ! empty( $this->query_vars['include'] ) ) {
-			$include     = wp_parse_id_list( $this->query_vars['include'] );
-			$include_sql = implode( ',', $include );
-			$_orderby    = "FIELD( $table.id, $include_sql )";
-		}
-
-		return $_orderby;
-	}
-
-	/**
-	 * Parse an 'order' query variable and cast it to ASC or DESC as necessary.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @param string $order The 'order' query variable.
-	 * @return string The sanitized 'order' query variable.
-	 */
-	protected function parse_order( $order ) {
-		if ( ! is_string( $order ) || empty( $order ) ) {
-			return 'DESC';
-		}
-
-		if ( 'ASC' === strtoupper( $order ) ) {
-			return 'ASC';
-		} else {
-			return 'DESC';
-		}
-	}
+    /**
+     * Query vars, after parsing
+     *
+     * @since 1.0.19
+     * @var array
+     */
+    public $query_vars = array();
+
+    /**
+     * List of found customers.
+     *
+     * @since 1.0.19
+     * @var array
+     */
+    private $results;
+
+    /**
+     * Total number of found customers for the current query
+     *
+     * @since 1.0.19
+     * @var int
+     */
+    private $total_customers = 0;
+
+    /**
+     * The SQL query used to fetch matching customers.
+     *
+     * @since 1.0.19
+     * @var string
+     */
+    public $request;
+
+    // SQL clauses
+
+    /**
+     * Contains the 'FIELDS' sql clause
+     *
+     * @since 1.0.19
+     * @var string
+     */
+    public $query_fields;
+
+    /**
+     * Contains the 'FROM' sql clause
+     *
+     * @since 1.0.19
+     * @var string
+     */
+    public $query_from;
+
+    /**
+     * Contains the 'WHERE' sql clause
+     *
+     * @since 1.0.19
+     * @var string
+     */
+    public $query_where;
+
+    /**
+     * Contains the 'ORDER BY' sql clause
+     *
+     * @since 1.0.19
+     * @var string
+     */
+    public $query_orderby;
+
+    /**
+     * Contains the 'LIMIT' sql clause
+     *
+     * @since 1.0.19
+     * @var string
+     */
+    public $query_limit;
+
+    /**
+     * Class constructor.
+     *
+     * @since 1.0.19
+     *
+     * @param null|string|array $query Optional. The query variables.
+     */
+    public function __construct( $query = null ) {
+        if ( ! is_null( $query ) ) {
+            $this->prepare_query( $query );
+            $this->query();
+        }
+    }
+
+    /**
+     * Fills in missing query variables with default values.
+     *
+     * @since 1.0.19
+     *
+     * @param  string|array $args Query vars, as passed to `GetPaid_Subscriptions_Query`.
+     * @return array Complete query variables with undefined ones filled in with defaults.
+     */
+    public static function fill_query_vars( $args ) {
+        $defaults = array(
+            'include'     => array(),
+            'exclude'     => array(),
+            'orderby'     => 'id',
+            'order'       => 'DESC',
+            'offset'      => '',
+            'number'      => 10,
+            'paged'       => 1,
+            'count_total' => true,
+            'fields'      => 'all',
+            's'           => '',
+        );
+
+        foreach ( GetPaid_Customer_Data_Store::get_database_fields() as $field => $type ) {
+            $defaults[ $field ] = 'any';
+
+            if ( '%f' === $type || '%d' === $type ) {
+                $defaults[ $field . '_min' ] = '';
+                $defaults[ $field . '_max' ] = '';
+            }
+        }
+
+        return wp_parse_args( $args, $defaults );
+    }
+
+    /**
+     * Prepare the query variables.
+     *
+     * @since 1.0.19
+     *
+     * @see self::fill_query_vars() For allowede args and their defaults.
+     */
+    public function prepare_query( $query = array() ) {
+        global $wpdb;
+
+        if ( empty( $this->query_vars ) || ! empty( $query ) ) {
+            $this->query_limit = null;
+            $this->query_vars  = $this->fill_query_vars( $query );
+        }
+
+        if ( ! empty( $this->query_vars['fields'] ) && 'all' !== $this->query_vars['fields'] ) {
+            $this->query_vars['fields'] = wpinv_parse_list( $this->query_vars['fields'] );
+        }
+
+        do_action( 'getpaid_pre_get_customers', array( &$this ) );
+
+        // Ensure that query vars are filled after 'getpaid_pre_get_customers'.
+        $qv                = & $this->query_vars;
+        $qv                = $this->fill_query_vars( $qv );
+        $table             = $wpdb->prefix . 'getpaid_customers';
+        $this->query_from  = "FROM $table";
+
+        // Prepare query fields.
+        $this->prepare_query_fields( $qv, $table );
+
+        // Prepare query where.
+        $this->prepare_query_where( $qv, $table );
+
+        // Prepare query order.
+        $this->prepare_query_order( $qv, $table );
+
+        // limit
+        if ( isset( $qv['number'] ) && $qv['number'] > 0 ) {
+            if ( $qv['offset'] ) {
+                $this->query_limit = $wpdb->prepare( 'LIMIT %d, %d', $qv['offset'], $qv['number'] );
+            } else {
+                $this->query_limit = $wpdb->prepare( 'LIMIT %d, %d', $qv['number'] * ( $qv['paged'] - 1 ), $qv['number'] );
+            }
+        }
+
+        do_action_ref_array( 'getpaid_after_customers_query', array( &$this ) );
+    }
+
+    /**
+     * Prepares the query fields.
+     *
+     * @since 1.0.19
+     *
+     * @param array $qv Query vars.
+     * @param string $table Table name.
+     */
+    protected function prepare_query_fields( &$qv, $table ) {
+
+        if ( is_array( $qv['fields'] ) ) {
+            $qv['fields']   = array_unique( $qv['fields'] );
+            $allowed_fields = array_keys( GetPaid_Customer_Data_Store::get_database_fields() );
+
+            $query_fields = array();
+            foreach ( $qv['fields'] as $field ) {
+                if ( ! in_array( $field, $allowed_fields ) ) {
+                    continue;
+                }
+
+                $field          = sanitize_key( $field );
+                $query_fields[] = "$table.`$field`";
+            }
+            $this->query_fields = implode( ',', $query_fields );
+        } else {
+            $this->query_fields = "$table.*";
+        }
+
+        if ( isset( $qv['count_total'] ) && $qv['count_total'] ) {
+            $this->query_fields = 'SQL_CALC_FOUND_ROWS ' . $this->query_fields;
+        }
+
+    }
+
+    /**
+     * Prepares the query where.
+     *
+     * @since 1.0.19
+     *
+     * @param array $qv Query vars.
+     * @param string $table Table name.
+     */
+    protected function prepare_query_where( &$qv, $table ) {
+        global $wpdb;
+        $this->query_where = 'WHERE 1=1';
+
+        // Fields.
+        foreach ( GetPaid_Customer_Data_Store::get_database_fields() as $field => $type ) {
+            if ( 'any' !== $qv[ $field ] ) {
+
+                // In.
+                if ( is_array( $qv[ $field ] ) ) {
+                    $in                 = join( ',', array_fill( 0, count( $qv[ $field ] ), $type ) );
+                    $this->query_where .= $wpdb->prepare( " AND $table.`status` IN ( $in )", $qv[ $field ] );
+                } elseif ( ! empty( $qv[ $field ] ) ) {
+                    $this->query_where .= $wpdb->prepare( " AND $table.`$field` = $type", $qv[ $field ] );
+                }
+            }
+
+            // Min/Max.
+            if ( '%f' === $type || '%d' === $type ) {
+
+                // Min.
+                if ( is_numeric( $qv[ $field . '_min' ] ) ) {
+                    $this->query_where .= $wpdb->prepare( " AND $table.`$field` >= $type", $qv[ $field . '_min' ] );
+                }
+
+                // Max.
+                if ( is_numeric( $qv[ $field . '_max' ] ) ) {
+                    $this->query_where .= $wpdb->prepare( " AND $table.`$field` <= $type", $qv[ $field . '_max' ] );
+                }
+            }
+        }
+
+        if ( ! empty( $qv['include'] ) ) {
+            $include            = implode( ',', wp_parse_id_list( $qv['include'] ) );
+            $this->query_where .= " AND $table.`id` IN ($include)";
+        } elseif ( ! empty( $qv['exclude'] ) ) {
+            $exclude            = implode( ',', wp_parse_id_list( $qv['exclude'] ) );
+            $this->query_where .= " AND $table.`id` NOT IN ($exclude)";
+        }
+
+        // Date queries are allowed for the customer creation date.
+        if ( ! empty( $qv['date_created_query'] ) && is_array( $qv['date_created_query'] ) ) {
+            $date_created_query = new WP_Date_Query( $qv['date_created_query'], "$table.date_created" );
+            $this->query_where .= $date_created_query->get_sql();
+        }
+
+        // Search.
+        if ( ! empty( $qv['s'] ) ) {
+            $this->query_where .= $this->get_search_sql( $qv['s'] );
+        }
+    }
+
+    /**
+     * Used internally to generate an SQL string for searching across multiple columns
+     *
+     * @since 1.2.7
+     *
+     * @global wpdb $wpdb WordPress database abstraction object.
+     *
+     * @param string $string The string to search for.
+     * @return string
+     */
+    protected function get_search_sql( $string ) {
+        global $wpdb;
+
+        $searches = array();
+        $string   = trim( $string, '%' );
+        $like     = '%' . $wpdb->esc_like( $string ) . '%';
+
+        foreach ( array_keys( GetPaid_Customer_Data_Store::get_database_fields() ) as $col ) {
+            if ( 'id' === $col || 'user_id' === $col ) {
+                $searches[] = $wpdb->prepare( "$col = %s", $string );  // phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared
+            } else {
+                $searches[] = $wpdb->prepare( "$col LIKE %s", $like );  // phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared
+            }
+        }
+
+        return ' AND (' . implode( ' OR ', $searches ) . ')';
+    }
+
+    /**
+     * Prepares the query order.
+     *
+     * @since 1.0.19
+     *
+     * @param array $qv Query vars.
+     * @param string $table Table name.
+     */
+    protected function prepare_query_order( &$qv, $table ) {
+
+        // sorting.
+        $qv['order'] = isset( $qv['order'] ) ? strtoupper( $qv['order'] ) : '';
+        $order       = $this->parse_order( $qv['order'] );
+
+        // Default order is by 'id' (latest customers).
+        if ( empty( $qv['orderby'] ) ) {
+            $qv['orderby'] = array( 'id' );
+        }
+
+        // 'orderby' values may be an array, comma- or space-separated list.
+        $ordersby      = array_filter( wpinv_parse_list( $qv['orderby'] ) );
+
+        $orderby_array = array();
+        foreach ( $ordersby as $_key => $_value ) {
+
+            if ( is_int( $_key ) ) {
+                // Integer key means this is a flat array of 'orderby' fields.
+                $_orderby = $_value;
+                $_order   = $order;
+            } else {
+                // Non-integer key means that the key is the field and the value is ASC/DESC.
+                $_orderby = $_key;
+                $_order   = $_value;
+            }
+
+            $parsed = $this->parse_orderby( $_orderby, $table );
+
+            if ( $parsed ) {
+                $orderby_array[] = $parsed . ' ' . $this->parse_order( $_order );
+            }
+        }
+
+        // If no valid clauses were found, order by id.
+        if ( empty( $orderby_array ) ) {
+            $orderby_array[] = "id $order";
+        }
+
+        $this->query_orderby = 'ORDER BY ' . implode( ', ', $orderby_array );
+
+    }
+
+    /**
+     * Execute the query, with the current variables.
+     *
+     * @since 1.0.19
+     *
+     * @global wpdb $wpdb WordPress database abstraction object.
+     */
+    public function query() {
+        global $wpdb;
+
+        $qv =& $this->query_vars;
+
+        // Return a non-null value to bypass the default GetPaid customers query and remember to set the
+        // total_customers property.
+        $this->results = apply_filters_ref_array( 'getpaid_customers_pre_query', array( null, &$this ) );
+
+        if ( null === $this->results ) {
+            $this->request = "SELECT $this->query_fields $this->query_from $this->query_where $this->query_orderby $this->query_limit";
+
+            if ( ( is_array( $qv['fields'] ) && 1 !== count( $qv['fields'] ) ) || 'all' === $qv['fields'] ) {
+                $this->results = $wpdb->get_results( $this->request );
+            } else {
+                $this->results = $wpdb->get_col( $this->request );
+            }
+
+            if ( isset( $qv['count_total'] ) && $qv['count_total'] ) {
+                $found_customers_query = apply_filters( 'getpaid_found_customers_query', 'SELECT FOUND_ROWS()', $this );
+                $this->total_customers = (int) $wpdb->get_var( $found_customers_query );
+            }
+        }
+
+        if ( 'all' === $qv['fields'] ) {
+            foreach ( $this->results as $key => $customer ) {
+                $this->set_cache( $customer->id, $customer, 'getpaid_customers' );
+                $this->set_cache( $customer->user_id, $customer->id, 'getpaid_customer_ids_by_user_id' );
+                $this->set_cache( $customer->email, $customer->id, 'getpaid_customer_ids_by_email' );
+                $this->results[ $key ] = new GetPaid_Customer( $customer );
+            }
+        }
+
+    }
+
+    /**
+     * Set cache
+     *
+     * @param string  $id
+     * @param mixed   $data
+     * @param string  $group
+     * @param integer $expire
+     * @return boolean
+     */
+    public function set_cache( $key, $data, $group = '', $expire = 0 ) {
+
+        if ( empty( $key ) ) {
+            return false;
+        }
+
+        wp_cache_set( $key, $data, $group, $expire );
+    }
+
+    /**
+     * Retrieve query variable.
+     *
+     * @since 1.0.19
+     *
+     * @param string $query_var Query variable key.
+     * @return mixed
+     */
+    public function get( $query_var ) {
+        if ( isset( $this->query_vars[ $query_var ] ) ) {
+            return $this->query_vars[ $query_var ];
+        }
+
+        return null;
+    }
+
+    /**
+     * Set query variable.
+     *
+     * @since 1.0.19
+     *
+     * @param string $query_var Query variable key.
+     * @param mixed $value Query variable value.
+     */
+    public function set( $query_var, $value ) {
+        $this->query_vars[ $query_var ] = $value;
+    }
+
+    /**
+     * Return the list of customers.
+     *
+     * @since 1.0.19
+     *
+     * @return GetPaid_Customer[]|array Found customers.
+     */
+    public function get_results() {
+        return $this->results;
+    }
+
+    /**
+     * Return the total number of customers for the current query.
+     *
+     * @since 1.0.19
+     *
+     * @return int Number of total customers.
+     */
+    public function get_total() {
+        return $this->total_customers;
+    }
+
+    /**
+     * Parse and sanitize 'orderby' keys passed to the customers query.
+     *
+     * @since 1.0.19
+     *
+     * @param string $orderby Alias for the field to order by.
+     *  @param string $table The current table.
+     * @return string Value to use in the ORDER clause, if `$orderby` is valid.
+     */
+    protected function parse_orderby( $orderby, $table ) {
+
+        $_orderby = '';
+        if ( in_array( $orderby, array_keys( GetPaid_Customer_Data_Store::get_database_fields() ), true ) ) {
+            $_orderby = "$table.`$orderby`";
+        } elseif ( 'id' === strtolower( $orderby ) ) {
+            $_orderby = "$table.id";
+        } elseif ( 'include' === $orderby && ! empty( $this->query_vars['include'] ) ) {
+            $include     = wp_parse_id_list( $this->query_vars['include'] );
+            $include_sql = implode( ',', $include );
+            $_orderby    = "FIELD( $table.id, $include_sql )";
+        }
+
+        return $_orderby;
+    }
+
+    /**
+     * Parse an 'order' query variable and cast it to ASC or DESC as necessary.
+     *
+     * @since 1.0.19
+     *
+     * @param string $order The 'order' query variable.
+     * @return string The sanitized 'order' query variable.
+     */
+    protected function parse_order( $order ) {
+        if ( ! is_string( $order ) || empty( $order ) ) {
+            return 'DESC';
+        }
+
+        if ( 'ASC' === strtoupper( $order ) ) {
+            return 'ASC';
+        } else {
+            return 'DESC';
+        }
+    }
 
 }

includes/admin/class-wpinv-customers-table.php

Indentation +296 added lines, -296 removed lines

@@ -11,7 +11,7 @@ 
 
 // Load WP_List_Table if not loaded
 if ( ! class_exists( 'WP_List_Table' ) ) {
-	require_once ABSPATH . 'wp-admin/includes/class-wp-list-table.php';
+    require_once ABSPATH . 'wp-admin/includes/class-wp-list-table.php';
 }
 
 /**
@@ -23,303 +23,303 @@ 
  */
 class WPInv_Customers_Table extends WP_List_Table {
 
-	/**
-	 * @var int Number of items per page
-	 * @since 1.0.19
-	 */
-	public $per_page = 25;
-
-	/**
-	 * @var int Number of items
-	 * @since 1.0.19
-	 */
-	public $total_count = 0;
-
-	public $query;
-
-	/**
-	 * Get things started
-	 *
-	 * @since 1.0.19
-	 * @see WP_List_Table::__construct()
-	 */
-	public function __construct() {
-
-		// Set parent defaults
-		parent::__construct(
+    /**
+     * @var int Number of items per page
+     * @since 1.0.19
+     */
+    public $per_page = 25;
+
+    /**
+     * @var int Number of items
+     * @since 1.0.19
+     */
+    public $total_count = 0;
+
+    public $query;
+
+    /**
+     * Get things started
+     *
+     * @since 1.0.19
+     * @see WP_List_Table::__construct()
+     */
+    public function __construct() {
+
+        // Set parent defaults
+        parent::__construct(
             array(
-				'singular' => 'id',
-				'plural'   => 'ids',
-				'ajax'     => false,
+                'singular' => 'id',
+                'plural'   => 'ids',
+                'ajax'     => false,
             )
         );
 
-	}
-
-	/**
-	 * Gets the name of the primary column.
-	 *
-	 * @since 1.0.19
-	 * @access protected
-	 *
-	 * @return string Name of the primary column.
-	 */
-	protected function get_primary_column_name() {
-		return 'customer';
-	}
-
-	/**
-	 * This function renders most of the columns in the list table.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @param GetPaid_Customer $customer
-	 * @param string $column_name The name of the column
-	 *
-	 * @return string Column Name
-	 */
-	public function column_default( $customer, $column_name ) {
-		$value = esc_html( $customer->get( $column_name ) );
-		return apply_filters( 'wpinv_customers_table_column' . $column_name, $value, $customer );
-	}
-
-	/**
-	 * Displays the country column.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @param GetPaid_Customer $customer
-	 *
-	 * @return string Column Name
-	 */
-	public function column_country( $customer ) {
-		$country = wpinv_sanitize_country( $customer->get( 'country' ) );
-		if ( $country ) {
-			$country = wpinv_country_name( $country );
-		}
-		return esc_html( $country );
-	}
-
-	/**
-	 * Displays the state column.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @param GetPaid_Customer $customer
-	 *
-	 * @return string Column Name
-	 */
-	public function column_state( $customer ) {
-		$country = wpinv_sanitize_country( $customer->get( 'country' ) );
-		$state   = $customer->get( 'state' );
-		if ( $state ) {
-			$state = wpinv_state_name( $state, $country );
-		}
-
-		return esc_html( $state );
-	}
-
-	/**
-	 * Displays the signup column.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @param GetPaid_Customer $customer
-	 *
-	 * @return string Column Name
-	 */
-	public function column_date_created( $customer ) {
-		return getpaid_format_date_value( $customer->get( 'date_created' ) );
-	}
-
-	/**
-	 * Displays the total spent column.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @param GetPaid_Customer $customer
-	 *
-	 * @return string Column Name
-	 */
-	public function column_purchase_value( $customer ) {
-		return wpinv_price( (float) $customer->get( 'purchase_value' ) );
-	}
-
-	/**
-	 * Displays the total spent column.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @param GetPaid_Customer $customer
-	 *
-	 * @return string Column Name
-	 */
-	public function column_purchase_count( $customer ) {
-		$value = $customer->get( 'purchase_count' );
-		$url   = $customer->get( 'user_id' ) ? add_query_arg( array( 'post_type' => 'wpi_invoice', 'author' => $customer->get( 'user_id' ), ), admin_url( 'edit.php' ) ) : '';
-
-		return ( empty( $value ) || empty( $url ) ) ? (int) $value : '<a href="' . esc_url( $url ) . '">' . absint( $value ) . '</a>';
-
-	}
-
-	/**
-	 * Displays the customers name
-	 *
-	 * @param  GetPaid_Customer $customer customer.
-	 * @return string
-	 */
-	public function column_customer( $customer ) {
-
-		$first_name = $customer->get( 'first_name' );
-		$last_name  = $customer->get( 'last_name' );
-		$email      = $customer->get( 'email' );
-		$avatar     = get_avatar( $customer->get( 'user_id' ) ? $customer->get( 'user_id' ) : $email, 32 );
-
-		// Customer view URL.
-		$view_url    = $customer->get( 'user_id' ) ? esc_url( add_query_arg( 'user_id', $customer->get( 'user_id' ), admin_url( 'user-edit.php' ) ) ) : false;
-		$row_actions = $view_url ? $this->row_actions(
-			array(
-				'view' => '<a href="' . $view_url . '#getpaid-fieldset-billing">' . __( 'Edit Details', 'invoicing' ) . '</a>',
-			)
-		) : '';
-
-		// Customer's name.
-		$name   = esc_html( trim( "$first_name $last_name" ) );
-
-		if ( ! empty( $name ) ) {
-			$name = "<div style='overflow: hidden;height: 18px;'>$name</div>";
-		}
-
-		$email = "<div class='row-title'><a href='mailto:$email'>$email</a></div>";
-
-		return "<div style='display: flex;'><div>$avatar</div><div style='margin-left: 10px;'>$name<strong>$email</strong>$row_actions</div></div>";
-
-	}
-
-	/**
-	 * Retrieve the current page number
-	 *
-	 * @since 1.0.19
-	 * @return int Current page number
-	 */
-	public function get_paged() {
-		return isset( $_GET['paged'] ) ? absint( $_GET['paged'] ) : 1;
-	}
-
-	/**
-	 * Returns bulk actions.
-	 *
-	 * @since 1.0.19
-	 * @return void
-	 */
-	public function bulk_actions( $which = '' ) {
-		return array();
-	}
-
-	/**
-	 *  Prepares the display query
-	 */
-	public function prepare_query() {
-
-		// Prepare query args.
-		$query = array(
-			'number' => $this->per_page,
-			'paged'  => $this->get_paged(),
-		);
-
-		foreach ( array( 'orderby', 'order', 's' ) as $field ) {
-			if ( isset( $_GET[ $field ] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended
-				$query[ $field ] = wpinv_clean( rawurlencode_deep( $_GET[ $field ] ) ); // phpcs:ignore WordPress.Security.NonceVerification.Recommended
-			}
-		}
-
-		foreach ( GetPaid_Customer_Data_Store::get_database_fields() as $field => $type ) {
-
-			if ( isset( $_GET[ $field ] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended
-				$query[ $field ] = wpinv_clean( rawurlencode_deep( $_GET[ $field ] ) ); // phpcs:ignore WordPress.Security.NonceVerification.Recommended
-			}
-
-			// Min max.
-			if ( '%f' === $type || '%d' === $type ) {
-
-				if ( isset( $_GET[ $field . '_min' ] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended
-					$query[ $field . '_min' ] = floatval( $_GET[ $field . '_min' ] ); // phpcs:ignore WordPress.Security.NonceVerification.Recommended
-				}
-
-				if ( isset( $_GET[ $field . '_max' ] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended
-					$query[ $field . '_max' ] = floatval( $_GET[ $field . '_max' ] ); // phpcs:ignore WordPress.Security.NonceVerification.Recommended
-				}
-			}
-		}
-
-		// Prepare class properties.
-		$this->query       = getpaid_get_customers( $query, 'query' );
-		$this->total_count = $this->query->get_total();
-		$this->items       = $this->query->get_results();
-	}
-
-	/**
-	 * Setup the final data for the table
-	 *
-	 */
-	public function prepare_items() {
-
-		$columns  = $this->get_columns();
-		$hidden   = array();
-		$sortable = $this->get_sortable_columns();
-		$this->prepare_query();
-
-		$this->_column_headers = array( $columns, $hidden, $sortable );
-
-		$this->set_pagination_args(
-			array(
-				'total_items' => $this->total_count,
-				'per_page'    => $this->per_page,
-				'total_pages' => ceil( $this->total_count / $this->per_page ),
-			)
-		);
-	}
-
-	/**
-	 * Sortable table columns.
-	 *
-	 * @return array
-	 */
-	public function get_sortable_columns() {
-		$sortable = array(
-			'customer' => array( 'first_name', true ),
-		);
-
-		foreach ( GetPaid_Customer_Data_Store::get_database_fields() as $field => $type ) {
-			$sortable[ $field ] = array( $field, true );
-		}
-
-		return apply_filters( 'manage_getpaid_customers_sortable_table_columns', $sortable );
-	}
-
-	/**
-	 * Table columns
-	 *
-	 * @return array
-	 */
-	public function get_columns() {
-		$columns = array(
-			'customer' => __( 'Customer', 'invoicing' ),
-		);
-
-		// Add address fields.
-		foreach ( getpaid_user_address_fields() as $key => $value ) {
-
-			// Skip id, user_id and email.
-			if ( ! in_array( $key, array( 'id', 'user_id', 'email', 'purchase_value', 'purchase_count', 'date_created', 'date_modified', 'uuid', 'first_name', 'last_name' ), true ) ) {
-				$columns[ $key ] = $value;
-			}
-		}
-
-		$columns['purchase_value'] = __( 'Total Spend', 'invoicing' );
-		$columns['purchase_count'] = __( 'Invoices', 'invoicing' );
-		$columns['date_created']   = __( 'Date created', 'invoicing' );
-
-		return apply_filters( 'manage_getpaid_customers_table_columns', $columns );
-	}
+    }
+
+    /**
+     * Gets the name of the primary column.
+     *
+     * @since 1.0.19
+     * @access protected
+     *
+     * @return string Name of the primary column.
+     */
+    protected function get_primary_column_name() {
+        return 'customer';
+    }
+
+    /**
+     * This function renders most of the columns in the list table.
+     *
+     * @since 1.0.19
+     *
+     * @param GetPaid_Customer $customer
+     * @param string $column_name The name of the column
+     *
+     * @return string Column Name
+     */
+    public function column_default( $customer, $column_name ) {
+        $value = esc_html( $customer->get( $column_name ) );
+        return apply_filters( 'wpinv_customers_table_column' . $column_name, $value, $customer );
+    }
+
+    /**
+     * Displays the country column.
+     *
+     * @since 1.0.19
+     *
+     * @param GetPaid_Customer $customer
+     *
+     * @return string Column Name
+     */
+    public function column_country( $customer ) {
+        $country = wpinv_sanitize_country( $customer->get( 'country' ) );
+        if ( $country ) {
+            $country = wpinv_country_name( $country );
+        }
+        return esc_html( $country );
+    }
+
+    /**
+     * Displays the state column.
+     *
+     * @since 1.0.19
+     *
+     * @param GetPaid_Customer $customer
+     *
+     * @return string Column Name
+     */
+    public function column_state( $customer ) {
+        $country = wpinv_sanitize_country( $customer->get( 'country' ) );
+        $state   = $customer->get( 'state' );
+        if ( $state ) {
+            $state = wpinv_state_name( $state, $country );
+        }
+
+        return esc_html( $state );
+    }
+
+    /**
+     * Displays the signup column.
+     *
+     * @since 1.0.19
+     *
+     * @param GetPaid_Customer $customer
+     *
+     * @return string Column Name
+     */
+    public function column_date_created( $customer ) {
+        return getpaid_format_date_value( $customer->get( 'date_created' ) );
+    }
+
+    /**
+     * Displays the total spent column.
+     *
+     * @since 1.0.19
+     *
+     * @param GetPaid_Customer $customer
+     *
+     * @return string Column Name
+     */
+    public function column_purchase_value( $customer ) {
+        return wpinv_price( (float) $customer->get( 'purchase_value' ) );
+    }
+
+    /**
+     * Displays the total spent column.
+     *
+     * @since 1.0.19
+     *
+     * @param GetPaid_Customer $customer
+     *
+     * @return string Column Name
+     */
+    public function column_purchase_count( $customer ) {
+        $value = $customer->get( 'purchase_count' );
+        $url   = $customer->get( 'user_id' ) ? add_query_arg( array( 'post_type' => 'wpi_invoice', 'author' => $customer->get( 'user_id' ), ), admin_url( 'edit.php' ) ) : '';
+
+        return ( empty( $value ) || empty( $url ) ) ? (int) $value : '<a href="' . esc_url( $url ) . '">' . absint( $value ) . '</a>';
+
+    }
+
+    /**
+     * Displays the customers name
+     *
+     * @param  GetPaid_Customer $customer customer.
+     * @return string
+     */
+    public function column_customer( $customer ) {
+
+        $first_name = $customer->get( 'first_name' );
+        $last_name  = $customer->get( 'last_name' );
+        $email      = $customer->get( 'email' );
+        $avatar     = get_avatar( $customer->get( 'user_id' ) ? $customer->get( 'user_id' ) : $email, 32 );
+
+        // Customer view URL.
+        $view_url    = $customer->get( 'user_id' ) ? esc_url( add_query_arg( 'user_id', $customer->get( 'user_id' ), admin_url( 'user-edit.php' ) ) ) : false;
+        $row_actions = $view_url ? $this->row_actions(
+            array(
+                'view' => '<a href="' . $view_url . '#getpaid-fieldset-billing">' . __( 'Edit Details', 'invoicing' ) . '</a>',
+            )
+        ) : '';
+
+        // Customer's name.
+        $name   = esc_html( trim( "$first_name $last_name" ) );
+
+        if ( ! empty( $name ) ) {
+            $name = "<div style='overflow: hidden;height: 18px;'>$name</div>";
+        }
+
+        $email = "<div class='row-title'><a href='mailto:$email'>$email</a></div>";
+
+        return "<div style='display: flex;'><div>$avatar</div><div style='margin-left: 10px;'>$name<strong>$email</strong>$row_actions</div></div>";
+
+    }
+
+    /**
+     * Retrieve the current page number
+     *
+     * @since 1.0.19
+     * @return int Current page number
+     */
+    public function get_paged() {
+        return isset( $_GET['paged'] ) ? absint( $_GET['paged'] ) : 1;
+    }
+
+    /**
+     * Returns bulk actions.
+     *
+     * @since 1.0.19
+     * @return void
+     */
+    public function bulk_actions( $which = '' ) {
+        return array();
+    }
+
+    /**
+     *  Prepares the display query
+     */
+    public function prepare_query() {
+
+        // Prepare query args.
+        $query = array(
+            'number' => $this->per_page,
+            'paged'  => $this->get_paged(),
+        );
+
+        foreach ( array( 'orderby', 'order', 's' ) as $field ) {
+            if ( isset( $_GET[ $field ] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended
+                $query[ $field ] = wpinv_clean( rawurlencode_deep( $_GET[ $field ] ) ); // phpcs:ignore WordPress.Security.NonceVerification.Recommended
+            }
+        }
+
+        foreach ( GetPaid_Customer_Data_Store::get_database_fields() as $field => $type ) {
+
+            if ( isset( $_GET[ $field ] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended
+                $query[ $field ] = wpinv_clean( rawurlencode_deep( $_GET[ $field ] ) ); // phpcs:ignore WordPress.Security.NonceVerification.Recommended
+            }
+
+            // Min max.
+            if ( '%f' === $type || '%d' === $type ) {
+
+                if ( isset( $_GET[ $field . '_min' ] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended
+                    $query[ $field . '_min' ] = floatval( $_GET[ $field . '_min' ] ); // phpcs:ignore WordPress.Security.NonceVerification.Recommended
+                }
+
+                if ( isset( $_GET[ $field . '_max' ] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended
+                    $query[ $field . '_max' ] = floatval( $_GET[ $field . '_max' ] ); // phpcs:ignore WordPress.Security.NonceVerification.Recommended
+                }
+            }
+        }
+
+        // Prepare class properties.
+        $this->query       = getpaid_get_customers( $query, 'query' );
+        $this->total_count = $this->query->get_total();
+        $this->items       = $this->query->get_results();
+    }
+
+    /**
+     * Setup the final data for the table
+     *
+     */
+    public function prepare_items() {
+
+        $columns  = $this->get_columns();
+        $hidden   = array();
+        $sortable = $this->get_sortable_columns();
+        $this->prepare_query();
+
+        $this->_column_headers = array( $columns, $hidden, $sortable );
+
+        $this->set_pagination_args(
+            array(
+                'total_items' => $this->total_count,
+                'per_page'    => $this->per_page,
+                'total_pages' => ceil( $this->total_count / $this->per_page ),
+            )
+        );
+    }
+
+    /**
+     * Sortable table columns.
+     *
+     * @return array
+     */
+    public function get_sortable_columns() {
+        $sortable = array(
+            'customer' => array( 'first_name', true ),
+        );
+
+        foreach ( GetPaid_Customer_Data_Store::get_database_fields() as $field => $type ) {
+            $sortable[ $field ] = array( $field, true );
+        }
+
+        return apply_filters( 'manage_getpaid_customers_sortable_table_columns', $sortable );
+    }
+
+    /**
+     * Table columns
+     *
+     * @return array
+     */
+    public function get_columns() {
+        $columns = array(
+            'customer' => __( 'Customer', 'invoicing' ),
+        );
+
+        // Add address fields.
+        foreach ( getpaid_user_address_fields() as $key => $value ) {
+
+            // Skip id, user_id and email.
+            if ( ! in_array( $key, array( 'id', 'user_id', 'email', 'purchase_value', 'purchase_count', 'date_created', 'date_modified', 'uuid', 'first_name', 'last_name' ), true ) ) {
+                $columns[ $key ] = $value;
+            }
+        }
+
+        $columns['purchase_value'] = __( 'Total Spend', 'invoicing' );
+        $columns['purchase_count'] = __( 'Invoices', 'invoicing' );
+        $columns['date_created']   = __( 'Date created', 'invoicing' );
+
+        return apply_filters( 'manage_getpaid_customers_table_columns', $columns );
+    }
 }

vendor/ayecode/ayecode-connect-helper/ayecode-connect-helper.php

Indentation +302 added lines, -302 removed lines

@@ -1,264 +1,264 @@ 
 <?php
 if ( ! defined( 'ABSPATH' ) ) {
-	exit;
+    exit;
 }
 
 if ( ! class_exists( "AyeCode_Connect_Helper" ) ) {
-	/**
-	 * Allow the quick setup and connection of our AyeCode Connect plugin.
-	 *
-	 * Class AyeCode_Connect_Helper
-	 */
-	class AyeCode_Connect_Helper {
-
-		// Hold the version number
-		var $version = "1.0.4";
-
-		// Hold the default strings.
-		var $strings = array();
-
-		// Hold the default pages.
-		var $pages = array();
-
-		/**
-		 * The constructor.
-		 *
-		 * AyeCode_Connect_Helper constructor.
-		 *
-		 * @param array $strings
-		 * @param array $pages
-		 */
-		public function __construct( $strings = array(), $pages = array() ) {
-			// Only fire if not localhost and the current user has the right permissions.
-			if ( ! $this->is_localhost() && current_user_can( 'manage_options' ) ) {
-				// set default strings
-				$default_strings = array(
-					'connect_title'     => __( "Thanks for choosing an AyeCode Product!", 'ayecode-connect' ),
-					'connect_external'  => __( "Please confirm you wish to connect your site?", 'ayecode-connect' ),
-					'connect'           => wp_sprintf( __( "<strong>Have a license?</strong> Forget about entering license keys or downloading zip files, connect your site for instant access. %slearn more%s", 'ayecode-connect' ), "<a href='https://ayecode.io/introducing-ayecode-connect/' target='_blank'>", "</a>" ),
-					'connect_button'    => __( "Connect Site", 'ayecode-connect' ),
-					'connecting_button' => __( "Connecting...", 'ayecode-connect' ),
-					'error_localhost'   => __( "This service will only work with a live domain, not a localhost.", 'ayecode-connect' ),
-					'error'             => __( "Something went wrong, please refresh and try again.", 'ayecode-connect' ),
-				);
-				$this->strings   = array_merge( $default_strings, $strings );
-
-				// set default pages
-				$default_pages = array();
-				$this->pages   = array_merge( $default_pages, $pages );
-
-				// maybe show connect site notice
-				add_action( 'admin_notices', array( $this, 'ayecode_connect_install_notice' ) );
-
-				// add ajax action if not already added
-				if ( ! has_action( 'wp_ajax_ayecode_connect_helper' ) ) {
-					add_action( 'wp_ajax_ayecode_connect_helper', array( $this, 'ayecode_connect_install' ) );
-				}
-			}
-
-			// add ajax action if not already added
-			if ( ! has_action( 'wp_ajax_nopriv_ayecode_connect_helper_installed' ) ) {
-				add_action( 'wp_ajax_nopriv_ayecode_connect_helper_installed', array( $this, 'ayecode_connect_helper_installed' ) );
-			}
-		}
-
-		/**
-		 * Give a way to check we can connect via a external redirect.
-		 */
-		public function ayecode_connect_helper_installed(){
-			$active = array(
-				'gd'    =>  defined('GEODIRECTORY_VERSION') && version_compare(GEODIRECTORY_VERSION,'2.0.0.79','>') ? 1 : 0,
-				'uwp'    =>  defined('USERSWP_VERSION') && version_compare(USERSWP_VERSION,'1.2.1.5','>') ? 1 : 0,
-				'wpi'    =>  defined('WPINV_VERSION') && version_compare(WPINV_VERSION,'1.0.14','>') ? 1 : 0,
-			);
-			wp_send_json_success( $active );
-			wp_die();
-		}
-
-		/**
-		 * Get slug from path
-		 *
-		 * @param  string $key
-		 *
-		 * @return string
-		 */
-		private function format_plugin_slug( $key ) {
-			$slug = explode( '/', $key );
-			$slug = explode( '.', end( $slug ) );
-
-			return $slug[0];
-		}
-
-		/**
-		 * Install and activate the AyeCode Connect Plugin
-		 */
-		public function ayecode_connect_install() {
-			// bail if localhost
-			if ( $this->is_localhost() ) {
-				wp_send_json_error( $this->strings['error_localhost'] );
-			}
-
-			// Explicitly clear the event.
-			wp_clear_scheduled_hook( 'geodir_plugin_background_installer', func_get_args() );
-
-			$success     = true;
-			$plugin_slug = "ayecode-connect";
-			if ( ! empty( $plugin_slug ) ) {
-				require_once( ABSPATH . 'wp-admin/includes/file.php' );
-				require_once( ABSPATH . 'wp-admin/includes/plugin-install.php' );
-				require_once( ABSPATH . 'wp-admin/includes/class-wp-upgrader.php' );
-				require_once( ABSPATH . 'wp-admin/includes/plugin.php' );
-
-				WP_Filesystem();
-
-				$skin              = new Automatic_Upgrader_Skin;
-				$upgrader          = new WP_Upgrader( $skin );
-				$installed_plugins = array_map( array( $this, 'format_plugin_slug' ), array_keys( get_plugins() ) );
-				$plugin_slug       = $plugin_slug;
-				$plugin            = $plugin_slug . '/' . $plugin_slug . '.php';
-				$installed         = false;
-				$activate          = false;
-
-				// See if the plugin is installed already
-				if ( in_array( $plugin_slug, $installed_plugins ) ) {
-					$installed = true;
-					$activate  = ! is_plugin_active( $plugin );
-				}
-
-				// Install this thing!
-				if ( ! $installed ) {
-
-					// Suppress feedback
-					ob_start();
-
-					try {
-						$plugin_information = plugins_api( 'plugin_information', array(
-							'slug'   => $plugin_slug,
-							'fields' => array(
-								'short_description' => false,
-								'sections'          => false,
-								'requires'          => false,
-								'rating'            => false,
-								'ratings'           => false,
-								'downloaded'        => false,
-								'last_updated'      => false,
-								'added'             => false,
-								'tags'              => false,
-								'homepage'          => false,
-								'donate_link'       => false,
-								'author_profile'    => false,
-								'author'            => false,
-							),
-						) );
-
-						if ( is_wp_error( $plugin_information ) ) {
-							throw new Exception( $plugin_information->get_error_message() );
-						}
-
-						$package  = $plugin_information->download_link;
-						$download = $upgrader->download_package( $package );
-
-						if ( is_wp_error( $download ) ) {
-							throw new Exception( $download->get_error_message() );
-						}
-
-						$working_dir = $upgrader->unpack_package( $download, true );
-
-						if ( is_wp_error( $working_dir ) ) {
-							throw new Exception( $working_dir->get_error_message() );
-						}
-
-						$result = $upgrader->install_package( array(
-							'source'                      => $working_dir,
-							'destination'                 => WP_PLUGIN_DIR,
-							'clear_destination'           => false,
-							'abort_if_destination_exists' => false,
-							'clear_working'               => true,
-							'hook_extra'                  => array(
-								'type'   => 'plugin',
-								'action' => 'install',
-							),
-						) );
-
-						if ( is_wp_error( $result ) ) {
-							throw new Exception( $result->get_error_message() );
-						}
-
-						$activate = true;
-
-					} catch ( Exception $e ) {
-						$success = false;
-					}
-
-					// Discard feedback
-					ob_end_clean();
-				}
-
-				wp_clean_plugins_cache();
-
-				// Activate this thing
-				if ( $activate ) {
-					try {
-						$result = activate_plugin( $plugin );
-
-						if ( is_wp_error( $result ) ) {
-							$success = false;
-						} else {
-							$success = true;
-						}
-					} catch ( Exception $e ) {
-						$success = false;
-					}
-				}
-			}
-
-			if ( $success && function_exists( 'ayecode_connect_args' ) ) {
-				ayecode_connect();// init
-				$args        = ayecode_connect_args();
-				$client      = new AyeCode_Connect( $args );
-				$redirect_to = ! empty( $_POST['redirect_to'] ) ? esc_url_raw( $_POST['redirect_to'] ) : '';
-				$redirect    = $client->build_connect_url( $redirect_to );
-				wp_send_json_success( array( 'connect_url' => $redirect ) );
-			} else {
-				wp_send_json_error( $this->strings['error_localhost'] );
-			}
-			wp_die();
-		}
-
-		/**
-		 * Check if maybe localhost.
-		 *
-		 * @return bool
-		 */
-		public function is_localhost() {
-			$localhost = false;
-
-			$host              = isset( $_SERVER['HTTP_HOST'] ) ? $_SERVER['HTTP_HOST'] : '';
-			$localhost_domains = array(
-				'localhost',
-				'localhost.localdomain',
-				'127.0.0.1',
-				'::1'
-			);
-
-			if ( in_array( $host, $localhost_domains ) ) {
-				$localhost = true;
-			}
-
-			return $localhost;
-		}
-
-		/**
-		 * Show notice to connect site.
-		 */
-		public function ayecode_connect_install_notice() {
-			if ( $this->maybe_show() ) {
-				$connect_title_string     = $this->strings['connect_title'];
-				$connect_external_string  = $this->strings['connect_external'];
-				$connect_string           = $this->strings['connect'];
-				$connect_button_string    = $this->strings['connect_button'];
-				$connecting_button_string = $this->strings['connecting_button'];
-				?>
+    /**
+     * Allow the quick setup and connection of our AyeCode Connect plugin.
+     *
+     * Class AyeCode_Connect_Helper
+     */
+    class AyeCode_Connect_Helper {
+
+        // Hold the version number
+        var $version = "1.0.4";
+
+        // Hold the default strings.
+        var $strings = array();
+
+        // Hold the default pages.
+        var $pages = array();
+
+        /**
+         * The constructor.
+         *
+         * AyeCode_Connect_Helper constructor.
+         *
+         * @param array $strings
+         * @param array $pages
+         */
+        public function __construct( $strings = array(), $pages = array() ) {
+            // Only fire if not localhost and the current user has the right permissions.
+            if ( ! $this->is_localhost() && current_user_can( 'manage_options' ) ) {
+                // set default strings
+                $default_strings = array(
+                    'connect_title'     => __( "Thanks for choosing an AyeCode Product!", 'ayecode-connect' ),
+                    'connect_external'  => __( "Please confirm you wish to connect your site?", 'ayecode-connect' ),
+                    'connect'           => wp_sprintf( __( "<strong>Have a license?</strong> Forget about entering license keys or downloading zip files, connect your site for instant access. %slearn more%s", 'ayecode-connect' ), "<a href='https://ayecode.io/introducing-ayecode-connect/' target='_blank'>", "</a>" ),
+                    'connect_button'    => __( "Connect Site", 'ayecode-connect' ),
+                    'connecting_button' => __( "Connecting...", 'ayecode-connect' ),
+                    'error_localhost'   => __( "This service will only work with a live domain, not a localhost.", 'ayecode-connect' ),
+                    'error'             => __( "Something went wrong, please refresh and try again.", 'ayecode-connect' ),
+                );
+                $this->strings   = array_merge( $default_strings, $strings );
+
+                // set default pages
+                $default_pages = array();
+                $this->pages   = array_merge( $default_pages, $pages );
+
+                // maybe show connect site notice
+                add_action( 'admin_notices', array( $this, 'ayecode_connect_install_notice' ) );
+
+                // add ajax action if not already added
+                if ( ! has_action( 'wp_ajax_ayecode_connect_helper' ) ) {
+                    add_action( 'wp_ajax_ayecode_connect_helper', array( $this, 'ayecode_connect_install' ) );
+                }
+            }
+
+            // add ajax action if not already added
+            if ( ! has_action( 'wp_ajax_nopriv_ayecode_connect_helper_installed' ) ) {
+                add_action( 'wp_ajax_nopriv_ayecode_connect_helper_installed', array( $this, 'ayecode_connect_helper_installed' ) );
+            }
+        }
+
+        /**
+         * Give a way to check we can connect via a external redirect.
+         */
+        public function ayecode_connect_helper_installed(){
+            $active = array(
+                'gd'    =>  defined('GEODIRECTORY_VERSION') && version_compare(GEODIRECTORY_VERSION,'2.0.0.79','>') ? 1 : 0,
+                'uwp'    =>  defined('USERSWP_VERSION') && version_compare(USERSWP_VERSION,'1.2.1.5','>') ? 1 : 0,
+                'wpi'    =>  defined('WPINV_VERSION') && version_compare(WPINV_VERSION,'1.0.14','>') ? 1 : 0,
+            );
+            wp_send_json_success( $active );
+            wp_die();
+        }
+
+        /**
+         * Get slug from path
+         *
+         * @param  string $key
+         *
+         * @return string
+         */
+        private function format_plugin_slug( $key ) {
+            $slug = explode( '/', $key );
+            $slug = explode( '.', end( $slug ) );
+
+            return $slug[0];
+        }
+
+        /**
+         * Install and activate the AyeCode Connect Plugin
+         */
+        public function ayecode_connect_install() {
+            // bail if localhost
+            if ( $this->is_localhost() ) {
+                wp_send_json_error( $this->strings['error_localhost'] );
+            }
+
+            // Explicitly clear the event.
+            wp_clear_scheduled_hook( 'geodir_plugin_background_installer', func_get_args() );
+
+            $success     = true;
+            $plugin_slug = "ayecode-connect";
+            if ( ! empty( $plugin_slug ) ) {
+                require_once( ABSPATH . 'wp-admin/includes/file.php' );
+                require_once( ABSPATH . 'wp-admin/includes/plugin-install.php' );
+                require_once( ABSPATH . 'wp-admin/includes/class-wp-upgrader.php' );
+                require_once( ABSPATH . 'wp-admin/includes/plugin.php' );
+
+                WP_Filesystem();
+
+                $skin              = new Automatic_Upgrader_Skin;
+                $upgrader          = new WP_Upgrader( $skin );
+                $installed_plugins = array_map( array( $this, 'format_plugin_slug' ), array_keys( get_plugins() ) );
+                $plugin_slug       = $plugin_slug;
+                $plugin            = $plugin_slug . '/' . $plugin_slug . '.php';
+                $installed         = false;
+                $activate          = false;
+
+                // See if the plugin is installed already
+                if ( in_array( $plugin_slug, $installed_plugins ) ) {
+                    $installed = true;
+                    $activate  = ! is_plugin_active( $plugin );
+                }
+
+                // Install this thing!
+                if ( ! $installed ) {
+
+                    // Suppress feedback
+                    ob_start();
+
+                    try {
+                        $plugin_information = plugins_api( 'plugin_information', array(
+                            'slug'   => $plugin_slug,
+                            'fields' => array(
+                                'short_description' => false,
+                                'sections'          => false,
+                                'requires'          => false,
+                                'rating'            => false,
+                                'ratings'           => false,
+                                'downloaded'        => false,
+                                'last_updated'      => false,
+                                'added'             => false,
+                                'tags'              => false,
+                                'homepage'          => false,
+                                'donate_link'       => false,
+                                'author_profile'    => false,
+                                'author'            => false,
+                            ),
+                        ) );
+
+                        if ( is_wp_error( $plugin_information ) ) {
+                            throw new Exception( $plugin_information->get_error_message() );
+                        }
+
+                        $package  = $plugin_information->download_link;
+                        $download = $upgrader->download_package( $package );
+
+                        if ( is_wp_error( $download ) ) {
+                            throw new Exception( $download->get_error_message() );
+                        }
+
+                        $working_dir = $upgrader->unpack_package( $download, true );
+
+                        if ( is_wp_error( $working_dir ) ) {
+                            throw new Exception( $working_dir->get_error_message() );
+                        }
+
+                        $result = $upgrader->install_package( array(
+                            'source'                      => $working_dir,
+                            'destination'                 => WP_PLUGIN_DIR,
+                            'clear_destination'           => false,
+                            'abort_if_destination_exists' => false,
+                            'clear_working'               => true,
+                            'hook_extra'                  => array(
+                                'type'   => 'plugin',
+                                'action' => 'install',
+                            ),
+                        ) );
+
+                        if ( is_wp_error( $result ) ) {
+                            throw new Exception( $result->get_error_message() );
+                        }
+
+                        $activate = true;
+
+                    } catch ( Exception $e ) {
+                        $success = false;
+                    }
+
+                    // Discard feedback
+                    ob_end_clean();
+                }
+
+                wp_clean_plugins_cache();
+
+                // Activate this thing
+                if ( $activate ) {
+                    try {
+                        $result = activate_plugin( $plugin );
+
+                        if ( is_wp_error( $result ) ) {
+                            $success = false;
+                        } else {
+                            $success = true;
+                        }
+                    } catch ( Exception $e ) {
+                        $success = false;
+                    }
+                }
+            }
+
+            if ( $success && function_exists( 'ayecode_connect_args' ) ) {
+                ayecode_connect();// init
+                $args        = ayecode_connect_args();
+                $client      = new AyeCode_Connect( $args );
+                $redirect_to = ! empty( $_POST['redirect_to'] ) ? esc_url_raw( $_POST['redirect_to'] ) : '';
+                $redirect    = $client->build_connect_url( $redirect_to );
+                wp_send_json_success( array( 'connect_url' => $redirect ) );
+            } else {
+                wp_send_json_error( $this->strings['error_localhost'] );
+            }
+            wp_die();
+        }
+
+        /**
+         * Check if maybe localhost.
+         *
+         * @return bool
+         */
+        public function is_localhost() {
+            $localhost = false;
+
+            $host              = isset( $_SERVER['HTTP_HOST'] ) ? $_SERVER['HTTP_HOST'] : '';
+            $localhost_domains = array(
+                'localhost',
+                'localhost.localdomain',
+                '127.0.0.1',
+                '::1'
+            );
+
+            if ( in_array( $host, $localhost_domains ) ) {
+                $localhost = true;
+            }
+
+            return $localhost;
+        }
+
+        /**
+         * Show notice to connect site.
+         */
+        public function ayecode_connect_install_notice() {
+            if ( $this->maybe_show() ) {
+                $connect_title_string     = $this->strings['connect_title'];
+                $connect_external_string  = $this->strings['connect_external'];
+                $connect_string           = $this->strings['connect'];
+                $connect_button_string    = $this->strings['connect_button'];
+                $connecting_button_string = $this->strings['connecting_button'];
+                ?>
 				<div class="notice notice-info acch-notice">
 					<span class="acch-float-left">
 						<svg width="61px" height="61px" viewBox="0 0 61 61" version="1.1"
@@ -305,9 +305,9 @@ 
 				</div>
 
 				<?php
-				// only include the popup HTML if needed.
-				if ( ! empty( $_REQUEST['external-connect-request'] ) ) {
-					?>
+                // only include the popup HTML if needed.
+                if ( ! empty( $_REQUEST['external-connect-request'] ) ) {
+                    ?>
 					<div id="ayecode-connect-helper-external-confirm" style="display:none;">
 						<div class="noticex notice-info acch-notice" style="border: none;">
 					<span class="acch-float-left">
@@ -353,23 +353,23 @@ 
 						</div>
 					</div>
 					<?php
-				}
-
-				// add required scripts
-				$this->script();
-			}
-		}
-
-		/**
-		 * Get the JS Script.
-		 */
-		public function script() {
-
-			// add thickbox if external request is requested
-			if ( ! empty( $_REQUEST['external-connect-request'] ) ) {
-				add_thickbox();
-			}
-			?>
+                }
+
+                // add required scripts
+                $this->script();
+            }
+        }
+
+        /**
+         * Get the JS Script.
+         */
+        public function script() {
+
+            // add thickbox if external request is requested
+            if ( ! empty( $_REQUEST['external-connect-request'] ) ) {
+                add_thickbox();
+            }
+            ?>
 			<style>
 				.acch-title {
 					margin: 0;
@@ -435,38 +435,38 @@ 
 					});
 				} 
 				<?php
-				// add thickbox if external request is requested
-				if(! empty( $_REQUEST['external-connect-request'] )) {
-				?>
+                // add thickbox if external request is requested
+                if(! empty( $_REQUEST['external-connect-request'] )) {
+                ?>
 				jQuery(function () {
 					setTimeout(function () {
 						tb_show("AyeCode Connect", "?TB_inline?width=300&height=80&inlineId=ayecode-connect-helper-external-confirm");
 					}, 200);
 				});
 				<?php
-				}
-				?>
+                }
+                ?>
 			</script>
 			<?php
-		}
-
-		/**
-		 * Decide what pages to show on.
-		 *
-		 * @return bool
-		 */
-		public function maybe_show() {
-			$show = false;
-
-			// check if on a page set to show
-			if ( isset( $_REQUEST['page'] ) && in_array( $_REQUEST['page'], $this->pages ) ) {
-				// check if not active and connected
-				if ( ! defined( 'AYECODE_CONNECT_VERSION' ) || ! get_option( 'ayecode_connect_blog_token' ) ) {
-					$show = true;
-				}
-			}
-
-			return $show;
-		}
-	}
+        }
+
+        /**
+         * Decide what pages to show on.
+         *
+         * @return bool
+         */
+        public function maybe_show() {
+            $show = false;
+
+            // check if on a page set to show
+            if ( isset( $_REQUEST['page'] ) && in_array( $_REQUEST['page'], $this->pages ) ) {
+                // check if not active and connected
+                if ( ! defined( 'AYECODE_CONNECT_VERSION' ) || ! get_option( 'ayecode_connect_blog_token' ) ) {
+                    $show = true;
+                }
+            }
+
+            return $show;
+        }
+    }
 }

vendor/ayecode/wp-deactivation-survey/wp-deactivation-survey.php

Indentation +75 added lines, -75 removed lines

@@ -1,99 +1,99 @@
 <?php
 
 if ( ! defined( 'ABSPATH' ) ) {
-	exit;
+    exit;
 }
 
 if ( ! class_exists( 'AyeCode_Deactivation_Survey' ) ) {
 
-	class AyeCode_Deactivation_Survey {
+    class AyeCode_Deactivation_Survey {
 
-		/**
-		 * AyeCode_Deactivation_Survey instance.
-		 *
-		 * @access private
-		 * @since  1.0.0
-		 * @var    AyeCode_Deactivation_Survey There can be only one!
-		 */
-		private static $instance = null;
+        /**
+         * AyeCode_Deactivation_Survey instance.
+         *
+         * @access private
+         * @since  1.0.0
+         * @var    AyeCode_Deactivation_Survey There can be only one!
+         */
+        private static $instance = null;
 
-		public static $plugins;
+        public static $plugins;
 
-		public $version = "1.0.7";
+        public $version = "1.0.7";
 
-		public static function instance( $plugin = array() ) {
-			if ( ! isset( self::$instance ) && ! ( self::$instance instanceof AyeCode_Deactivation_Survey ) ) {
-				self::$instance = new AyeCode_Deactivation_Survey;
-				self::$plugins = array();
+        public static function instance( $plugin = array() ) {
+            if ( ! isset( self::$instance ) && ! ( self::$instance instanceof AyeCode_Deactivation_Survey ) ) {
+                self::$instance = new AyeCode_Deactivation_Survey;
+                self::$plugins = array();
 
-				add_action( 'admin_enqueue_scripts', array( self::$instance, 'scripts' ) );
+                add_action( 'admin_enqueue_scripts', array( self::$instance, 'scripts' ) );
 
-				do_action( 'ayecode_deactivation_survey_loaded' );
-			}
+                do_action( 'ayecode_deactivation_survey_loaded' );
+            }
 
-			if(!empty($plugin)){
-				self::$plugins[] = (object)$plugin;
-			}
+            if(!empty($plugin)){
+                self::$plugins[] = (object)$plugin;
+            }
 
-			return self::$instance;
-		}
+            return self::$instance;
+        }
 
-		public function scripts() {
-			global $pagenow;
+        public function scripts() {
+            global $pagenow;
 
-			// Bail if we are not on the plugins page
-			if ( $pagenow != "plugins.php" ) {
-				return;
-			}
+            // Bail if we are not on the plugins page
+            if ( $pagenow != "plugins.php" ) {
+                return;
+            }
 
-			// Enqueue scripts
-			add_thickbox();
-			wp_enqueue_script('ayecode-deactivation-survey', plugin_dir_url(__FILE__) . 'ayecode-ds.js');
+            // Enqueue scripts
+            add_thickbox();
+            wp_enqueue_script('ayecode-deactivation-survey', plugin_dir_url(__FILE__) . 'ayecode-ds.js');
 
-			/*
+            /*
 			 * Localized strings. Strings can be localised by plugins using this class.
 			 * We deliberately don't add textdomains here so that double textdomain warning is not given in theme review.
 			 */
-			wp_localize_script('ayecode-deactivation-survey', 'ayecodeds_deactivate_feedback_form_strings', array(
-				'quick_feedback'			=> __( 'Quick Feedback', 'ayecode-connect' ),
-				'foreword'					=> __( 'If you would be kind enough, please tell us why you\'re deactivating?', 'ayecode-connect' ),
-				'better_plugins_name'		=> __( 'Please tell us which plugin?', 'ayecode-connect' ),
-				'please_tell_us'			=> __( 'Please tell us the reason so we can improve the plugin', 'ayecode-connect' ),
-				'do_not_attach_email'		=> __( 'Do not send my e-mail address with this feedback', 'ayecode-connect' ),
-				'brief_description'			=> __( 'Please give us any feedback that could help us improve', 'ayecode-connect' ),
-				'cancel'					=> __( 'Cancel', 'ayecode-connect' ),
-				'skip_and_deactivate'		=> __( 'Skip &amp; Deactivate', 'ayecode-connect' ),
-				'submit_and_deactivate'		=> __( 'Submit &amp; Deactivate', 'ayecode-connect' ),
-				'please_wait'				=> __( 'Please wait', 'ayecode-connect' ),
-				'get_support'				=> __( 'Get Support', 'ayecode-connect' ),
-				'documentation'				=> __( 'Documentation', 'ayecode-connect' ),
-				'thank_you'					=> __( 'Thank you!', 'ayecode-connect' ),
-			));
-
-			// Plugins
-			$plugins = apply_filters('ayecode_deactivation_survey_plugins', self::$plugins);
-
-			// Reasons
-			$defaultReasons = array(
-				'suddenly-stopped-working'	=> __( 'The plugin suddenly stopped working', 'ayecode-connect' ),
-				'plugin-broke-site'			=> __( 'The plugin broke my site', 'ayecode-connect' ),
-				'plugin-setup-difficult'	=> __( 'Too difficult to setup', 'ayecode-connect' ),
-				'plugin-design-difficult'	=> __( 'Too difficult to get the design i want', 'ayecode-connect' ),
-				'no-longer-needed'			=> __( 'I don\'t need this plugin any more', 'ayecode-connect' ),
-				'found-better-plugin'		=> __( 'I found a better plugin', 'ayecode-connect' ),
-				'temporary-deactivation'	=> __( 'It\'s a temporary deactivation, I\'m troubleshooting', 'ayecode-connect' ),
-				'other'						=> __( 'Other', 'ayecode-connect' ),
-			);
-
-			foreach( $plugins as $plugin ) {
-				$plugin->reasons = apply_filters( 'ayecode_deactivation_survey_reasons', $defaultReasons, $plugin );
-				$plugin->url = home_url();
-				$plugin->activated = 0;
-			}
-
-			// Send plugin data
-			wp_localize_script('ayecode-deactivation-survey', 'ayecodeds_deactivate_feedback_form_plugins', $plugins);
-		}
-	}
+            wp_localize_script('ayecode-deactivation-survey', 'ayecodeds_deactivate_feedback_form_strings', array(
+                'quick_feedback'			=> __( 'Quick Feedback', 'ayecode-connect' ),
+                'foreword'					=> __( 'If you would be kind enough, please tell us why you\'re deactivating?', 'ayecode-connect' ),
+                'better_plugins_name'		=> __( 'Please tell us which plugin?', 'ayecode-connect' ),
+                'please_tell_us'			=> __( 'Please tell us the reason so we can improve the plugin', 'ayecode-connect' ),
+                'do_not_attach_email'		=> __( 'Do not send my e-mail address with this feedback', 'ayecode-connect' ),
+                'brief_description'			=> __( 'Please give us any feedback that could help us improve', 'ayecode-connect' ),
+                'cancel'					=> __( 'Cancel', 'ayecode-connect' ),
+                'skip_and_deactivate'		=> __( 'Skip &amp; Deactivate', 'ayecode-connect' ),
+                'submit_and_deactivate'		=> __( 'Submit &amp; Deactivate', 'ayecode-connect' ),
+                'please_wait'				=> __( 'Please wait', 'ayecode-connect' ),
+                'get_support'				=> __( 'Get Support', 'ayecode-connect' ),
+                'documentation'				=> __( 'Documentation', 'ayecode-connect' ),
+                'thank_you'					=> __( 'Thank you!', 'ayecode-connect' ),
+            ));
+
+            // Plugins
+            $plugins = apply_filters('ayecode_deactivation_survey_plugins', self::$plugins);
+
+            // Reasons
+            $defaultReasons = array(
+                'suddenly-stopped-working'	=> __( 'The plugin suddenly stopped working', 'ayecode-connect' ),
+                'plugin-broke-site'			=> __( 'The plugin broke my site', 'ayecode-connect' ),
+                'plugin-setup-difficult'	=> __( 'Too difficult to setup', 'ayecode-connect' ),
+                'plugin-design-difficult'	=> __( 'Too difficult to get the design i want', 'ayecode-connect' ),
+                'no-longer-needed'			=> __( 'I don\'t need this plugin any more', 'ayecode-connect' ),
+                'found-better-plugin'		=> __( 'I found a better plugin', 'ayecode-connect' ),
+                'temporary-deactivation'	=> __( 'It\'s a temporary deactivation, I\'m troubleshooting', 'ayecode-connect' ),
+                'other'						=> __( 'Other', 'ayecode-connect' ),
+            );
+
+            foreach( $plugins as $plugin ) {
+                $plugin->reasons = apply_filters( 'ayecode_deactivation_survey_reasons', $defaultReasons, $plugin );
+                $plugin->url = home_url();
+                $plugin->activated = 0;
+            }
+
+            // Send plugin data
+            wp_localize_script('ayecode-deactivation-survey', 'ayecodeds_deactivate_feedback_form_plugins', $plugins);
+        }
+    }
 
 }
\ No newline at end of file

vendor/ayecode/wp-super-duper/map.php

Indentation +226 added lines, -226 removed lines

@@ -3,241 +3,241 @@
 class SD_Map extends WP_Super_Duper {
 
 
-	public $arguments;
-
-	/**
-	 * Sets up the widgets name etc
-	 */
-	public function __construct() {
-
-		$options = array(
-			'textdomain'     => 'super-duper',
-			// textdomain of the plugin/theme (used to prefix the Gutenberg block)
-			'block-icon'     => 'admin-site',
-			// Dash icon name for the block: https://developer.wordpress.org/resource/dashicons/#arrow-right
-			'block-category' => 'widgets',
-			// the category for the block, 'common', 'formatting', 'layout', 'widgets', 'embed'.
-			'block-keywords' => "['map','super','google']",
-			// used in the block search, MAX 3
-			'block-output'   => array( // the block visual output elements as an array
-				array(
-					'element' => 'p',
-					'content' => __('A Google API key is required to use this block, we recommend installing our plugin which makes it easy and sets it globally, or you can set a key in the block settings sidebar: ', 'ayecode-connect' ),
-					//'element_require' => '"1"=='.get_option( 'rgmk_google_map_api_key', '"0"') ? '"0"' : '"1"',
-					'element_require' => get_option( 'rgmk_google_map_api_key', false) ? '1==0' : '1==1 && [%api_key%]==""',
-				),
-				array(
-					'element' => 'a',
-					'content' => __('API KEY for Google Maps', 'ayecode-connect' ),
-					'element_require' => get_option( 'rgmk_google_map_api_key', false) ? '1==0' : '1==1 && [%api_key%]==""',
-					'href' => 'https://wordpress.org/plugins/api-key-for-google-maps/',
-				),
-				array(
-					'element' => 'img',
-					'class'   => '[%className%]',
-					//'content' => 'Hello: [%after_text%]' // block properties can be added by wrapping them in [%name%]
-					'element_require' => '[%type%]=="image"',
-					'src'     => get_option( 'rgmk_google_map_api_key', false) ? "https://maps.googleapis.com/maps/api/staticmap?center=[%location%]&maptype=[%maptype%]&zoom=[%zoom%]&size=[%static_width%]x[%static_height%]&key=".get_option( 'rgmk_google_map_api_key') : "https://maps.googleapis.com/maps/api/staticmap?center=[%location%]&maptype=[%maptype%]&zoom=[%zoom%]&size=[%static_width%]x[%static_height%]&key=[%api_key%]"
-				),
-				array(
-					'element' => 'div',
-					'class'   => 'sd-map-iframe-cover',
-					'style'   => '{overflow:"hidden", position:"relative"}',
-					array(
-						'element' => 'iframe',
-						'title'   => __( 'Placeholderx', 'ayecode-connect' ),
-						'class'   => '[%className%]',
-						'width'   => '[%width%]',
-						'height'  => '[%height%]',
-						'frameborder' => '0',
-						'allowfullscreen' => 'true',
-						'style' => '{border:0}',
-						'element_require' => '[%type%]!="image"',
-						'src'     => get_option( 'rgmk_google_map_api_key', false) ? "https://www.google.com/maps/embed/v1/[%type%]?q=[%location%]&maptype=[%maptype%]&zoom=[%zoom%]&key=".get_option( 'rgmk_google_map_api_key') : "https://www.google.com/maps/embed/v1/[%type%]?q=[%location%]&maptype=[%maptype%]&zoom=[%zoom%]&key=[%api_key%]"
-					),
-				),
-				array(
-					'element' => 'style',
-					'content' => '.sd-map-iframe-cover:hover:before {background: #4a4a4a88; content: "'.__( 'Click here, Settings are in the block settings sidebar', 'ayecode-connect' ).'";} .sd-map-iframe-cover:before{cursor: pointer; content: ""; width: 100%; height: 100%; position: absolute; top: 0; bottom: 0;padding-top: 33%; text-align: center;  color: #fff; font-size: 20px; font-weight: bold;}',
-					'element_require' => '[%type%]!="image"',
-				),
-			),
-			'class_name'     => __CLASS__,
-			// The calling class name
-			'base_id'        => 'sd_map',
-			// this is used as the widget id and the shortcode id.
-			'name'           => __( 'Map', 'ayecode-connect' ),
-			// the name of the widget/block
-			'widget_ops'     => array(
-				'classname'   => 'sd-map-class',
-				// widget class
-				'description' => esc_html__( 'This is an example that will take a text parameter and output it after `Hello:`.', 'ayecode-connect' ),
-				// widget description
-			),
-			'arguments'      => array( // these are the arguments that will be used in the widget, shortcode and block settings.
-				'type'  => array(
-					'title' => __('Map Type:', 'ayecode-connect'),
-					'desc' => __('Select the map type to use.', 'ayecode-connect'),
-					'type' => 'select',
-					'options'   =>  array(
-						"image" => __('Static Image', 'ayecode-connect'),
-						"place" => __('Place', 'ayecode-connect'),
+    public $arguments;
+
+    /**
+     * Sets up the widgets name etc
+     */
+    public function __construct() {
+
+        $options = array(
+            'textdomain'     => 'super-duper',
+            // textdomain of the plugin/theme (used to prefix the Gutenberg block)
+            'block-icon'     => 'admin-site',
+            // Dash icon name for the block: https://developer.wordpress.org/resource/dashicons/#arrow-right
+            'block-category' => 'widgets',
+            // the category for the block, 'common', 'formatting', 'layout', 'widgets', 'embed'.
+            'block-keywords' => "['map','super','google']",
+            // used in the block search, MAX 3
+            'block-output'   => array( // the block visual output elements as an array
+                array(
+                    'element' => 'p',
+                    'content' => __('A Google API key is required to use this block, we recommend installing our plugin which makes it easy and sets it globally, or you can set a key in the block settings sidebar: ', 'ayecode-connect' ),
+                    //'element_require' => '"1"=='.get_option( 'rgmk_google_map_api_key', '"0"') ? '"0"' : '"1"',
+                    'element_require' => get_option( 'rgmk_google_map_api_key', false) ? '1==0' : '1==1 && [%api_key%]==""',
+                ),
+                array(
+                    'element' => 'a',
+                    'content' => __('API KEY for Google Maps', 'ayecode-connect' ),
+                    'element_require' => get_option( 'rgmk_google_map_api_key', false) ? '1==0' : '1==1 && [%api_key%]==""',
+                    'href' => 'https://wordpress.org/plugins/api-key-for-google-maps/',
+                ),
+                array(
+                    'element' => 'img',
+                    'class'   => '[%className%]',
+                    //'content' => 'Hello: [%after_text%]' // block properties can be added by wrapping them in [%name%]
+                    'element_require' => '[%type%]=="image"',
+                    'src'     => get_option( 'rgmk_google_map_api_key', false) ? "https://maps.googleapis.com/maps/api/staticmap?center=[%location%]&maptype=[%maptype%]&zoom=[%zoom%]&size=[%static_width%]x[%static_height%]&key=".get_option( 'rgmk_google_map_api_key') : "https://maps.googleapis.com/maps/api/staticmap?center=[%location%]&maptype=[%maptype%]&zoom=[%zoom%]&size=[%static_width%]x[%static_height%]&key=[%api_key%]"
+                ),
+                array(
+                    'element' => 'div',
+                    'class'   => 'sd-map-iframe-cover',
+                    'style'   => '{overflow:"hidden", position:"relative"}',
+                    array(
+                        'element' => 'iframe',
+                        'title'   => __( 'Placeholderx', 'ayecode-connect' ),
+                        'class'   => '[%className%]',
+                        'width'   => '[%width%]',
+                        'height'  => '[%height%]',
+                        'frameborder' => '0',
+                        'allowfullscreen' => 'true',
+                        'style' => '{border:0}',
+                        'element_require' => '[%type%]!="image"',
+                        'src'     => get_option( 'rgmk_google_map_api_key', false) ? "https://www.google.com/maps/embed/v1/[%type%]?q=[%location%]&maptype=[%maptype%]&zoom=[%zoom%]&key=".get_option( 'rgmk_google_map_api_key') : "https://www.google.com/maps/embed/v1/[%type%]?q=[%location%]&maptype=[%maptype%]&zoom=[%zoom%]&key=[%api_key%]"
+                    ),
+                ),
+                array(
+                    'element' => 'style',
+                    'content' => '.sd-map-iframe-cover:hover:before {background: #4a4a4a88; content: "'.__( 'Click here, Settings are in the block settings sidebar', 'ayecode-connect' ).'";} .sd-map-iframe-cover:before{cursor: pointer; content: ""; width: 100%; height: 100%; position: absolute; top: 0; bottom: 0;padding-top: 33%; text-align: center;  color: #fff; font-size: 20px; font-weight: bold;}',
+                    'element_require' => '[%type%]!="image"',
+                ),
+            ),
+            'class_name'     => __CLASS__,
+            // The calling class name
+            'base_id'        => 'sd_map',
+            // this is used as the widget id and the shortcode id.
+            'name'           => __( 'Map', 'ayecode-connect' ),
+            // the name of the widget/block
+            'widget_ops'     => array(
+                'classname'   => 'sd-map-class',
+                // widget class
+                'description' => esc_html__( 'This is an example that will take a text parameter and output it after `Hello:`.', 'ayecode-connect' ),
+                // widget description
+            ),
+            'arguments'      => array( // these are the arguments that will be used in the widget, shortcode and block settings.
+                'type'  => array(
+                    'title' => __('Map Type:', 'ayecode-connect'),
+                    'desc' => __('Select the map type to use.', 'ayecode-connect'),
+                    'type' => 'select',
+                    'options'   =>  array(
+                        "image" => __('Static Image', 'ayecode-connect'),
+                        "place" => __('Place', 'ayecode-connect'),
 //						"directions" => __('Directions', 'ayecode-connect'),
 //						"search" => __('Search', 'ayecode-connect'),
 //						"view" => __('View', 'ayecode-connect'),
 //						"streetview" => __('Streetview', 'ayecode-connect'),
-					),
-					'default'  => 'image',
-					'desc_tip' => true,
-					'advanced' => false
-				),
-				'location'            => array(
-					'type'        => 'text',
-					'title'       => __( 'Location:', 'ayecode-connect' ),
-					'desc'        => __( 'Enter the location to show on the map, place, city, zip code or GPS.', 'ayecode-connect' ),
-					'placeholder' => 'Place, city, zip code or GPS',
-					'desc_tip'    => true,
-					'default'     => 'Ireland',
-					'advanced'    => false
-				),
-				'static_width'            => array(
-					'type'        => 'number',
-					'title'       => __( 'Width:', 'ayecode-connect' ),
-					'desc'        => __( 'This is the width of the map, for static maps you can only use px values.', 'ayecode-connect' ),
-					'placeholder' => '600',
-					'desc_tip'    => true,
-					'default'     => '600',
-					'custom_attributes' => array(
-						'max'         => '2000',
-						'min'         => '100',
-					),
-					'element_require' => '[%type%]=="image"',
-					'advanced'    => false
-				),
-				'static_height'           => array(
-					'type'        => 'number',
-					'title'       => __( 'Height:', 'ayecode-connect' ),
-					'desc'        => __( 'This is the height of the map, for static maps you can only use px values.', 'ayecode-connect' ),
-					'placeholder' => '400',
-					'desc_tip'    => true,
-					'default'     => '400',
-					'custom_attributes' => array(
-						'max'         => '2000',
-						'min'         => '100',
-						'required'         => 'required',
-					),
-					'element_require' => '[%type%]=="image"',
-					'advanced'    => false
-				),
-				'width'            => array(
-					'type'        => 'text',
-					'title'       => __( 'Width:', 'ayecode-connect' ),
-					'desc'        => __( 'This is the width of the map, you can use % or px here.', 'ayecode-connect' ),
-					'placeholder' => '100%',
-					'desc_tip'    => true,
-					'default'     => '100%',
-					'element_require' => '[%type%]!="image"',
-					'advanced'    => false
-				),
-				'height'           => array(
-					'type'        => 'text',
-					'title'       => __( 'Height:', 'ayecode-connect' ),
-					'desc'        => __( 'This is the height of the map, you can use %, px or vh here.', 'ayecode-connect' ),
-					'placeholder' => '425px',
-					'desc_tip'    => true,
-					'default'     => '425px',
-					'element_require' => '[%type%]!="image"',
-					'advanced'    => false
-				),
-				'maptype'          => array(
-					'type'     => 'select',
-					'title'    => __( 'Mapview:', 'ayecode-connect' ),
-					'desc'     => __( 'This is the type of map view that will be used by default.', 'ayecode-connect' ),
-					'options'  => array(
-						"roadmap"   => __( 'Road Map', 'ayecode-connect' ),
-						"satellite" => __( 'Satellite Map', 'ayecode-connect' ),
+                    ),
+                    'default'  => 'image',
+                    'desc_tip' => true,
+                    'advanced' => false
+                ),
+                'location'            => array(
+                    'type'        => 'text',
+                    'title'       => __( 'Location:', 'ayecode-connect' ),
+                    'desc'        => __( 'Enter the location to show on the map, place, city, zip code or GPS.', 'ayecode-connect' ),
+                    'placeholder' => 'Place, city, zip code or GPS',
+                    'desc_tip'    => true,
+                    'default'     => 'Ireland',
+                    'advanced'    => false
+                ),
+                'static_width'            => array(
+                    'type'        => 'number',
+                    'title'       => __( 'Width:', 'ayecode-connect' ),
+                    'desc'        => __( 'This is the width of the map, for static maps you can only use px values.', 'ayecode-connect' ),
+                    'placeholder' => '600',
+                    'desc_tip'    => true,
+                    'default'     => '600',
+                    'custom_attributes' => array(
+                        'max'         => '2000',
+                        'min'         => '100',
+                    ),
+                    'element_require' => '[%type%]=="image"',
+                    'advanced'    => false
+                ),
+                'static_height'           => array(
+                    'type'        => 'number',
+                    'title'       => __( 'Height:', 'ayecode-connect' ),
+                    'desc'        => __( 'This is the height of the map, for static maps you can only use px values.', 'ayecode-connect' ),
+                    'placeholder' => '400',
+                    'desc_tip'    => true,
+                    'default'     => '400',
+                    'custom_attributes' => array(
+                        'max'         => '2000',
+                        'min'         => '100',
+                        'required'         => 'required',
+                    ),
+                    'element_require' => '[%type%]=="image"',
+                    'advanced'    => false
+                ),
+                'width'            => array(
+                    'type'        => 'text',
+                    'title'       => __( 'Width:', 'ayecode-connect' ),
+                    'desc'        => __( 'This is the width of the map, you can use % or px here.', 'ayecode-connect' ),
+                    'placeholder' => '100%',
+                    'desc_tip'    => true,
+                    'default'     => '100%',
+                    'element_require' => '[%type%]!="image"',
+                    'advanced'    => false
+                ),
+                'height'           => array(
+                    'type'        => 'text',
+                    'title'       => __( 'Height:', 'ayecode-connect' ),
+                    'desc'        => __( 'This is the height of the map, you can use %, px or vh here.', 'ayecode-connect' ),
+                    'placeholder' => '425px',
+                    'desc_tip'    => true,
+                    'default'     => '425px',
+                    'element_require' => '[%type%]!="image"',
+                    'advanced'    => false
+                ),
+                'maptype'          => array(
+                    'type'     => 'select',
+                    'title'    => __( 'Mapview:', 'ayecode-connect' ),
+                    'desc'     => __( 'This is the type of map view that will be used by default.', 'ayecode-connect' ),
+                    'options'  => array(
+                        "roadmap"   => __( 'Road Map', 'ayecode-connect' ),
+                        "satellite" => __( 'Satellite Map', 'ayecode-connect' ),
 //						"hybrid"    => __( 'Hybrid Map', 'ayecode-connect' ),
 //						"terrain"   => __( 'Terrain Map', 'ayecode-connect' ),
-					),
-					'desc_tip' => true,
-					'default'  => 'roadmap',
-					'advanced' => true
-				),
-				'zoom'             => array(
-					'type'        => 'select',
-					'title'       => __( 'Zoom level:', 'ayecode-connect' ),
-					'desc'        => __( 'This is the zoom level of the map, `auto` is recommended.', 'ayecode-connect' ),
-					'options'     => range( 1, 19 ),
-					'placeholder' => '',
-					'desc_tip'    => true,
-					'default'     => '7',
-					'advanced'    => true
-				),
-				'api_key'           => array(
-					'type'        => 'text',
-					'title'       => __( 'Api Key:', 'ayecode-connect' ),
-					'desc'        => __( 'This is the height of the map, you can use %, px or vh here.', 'ayecode-connect' ),
-					'placeholder' => '',
-					'desc_tip'    => true,
-					'default'     => '',
-					'element_require' => get_option( 'rgmk_google_map_api_key', false) ? '1==0' : '1==1',
-					'advanced'    => false
-				),
-			)
-		);
-
-		parent::__construct( $options );
-	}
-
-
-	/**
-	 * This is the output function for the widget, shortcode and block (front end).
-	 *
-	 * @param array $args The arguments values.
-	 * @param array $widget_args The widget arguments when used.
-	 * @param string $content The shortcode content argument
-	 *
-	 * @return string
-	 */
-	public function output( $args = array(), $widget_args = array(), $content = '' ) {
-
-		// options
-		$defaults = array(
-			'type'      => 'image', // image, place
-			'location' => 'Ireland',
-			'static_width' => '600',
-			'static_height' => '400',
-			'width'=> '100%',
-			'height'=> '425px',
-			'maptype'     => 'roadmap',
-			'zoom'     => '7',
-			'api_key'     => 'AIzaSyBK3ZcmK0ljxl5agNyJNQh_G24Thq1btuE',
-		);
-
-		/**
-		 * Parse incoming $args into an array and merge it with $defaults
-		 */
-		$args = wp_parse_args($args, $defaults );
-
-		$output = '';
-
-
-		// check if we have a global API key
-		$args['api_key'] = get_option( 'rgmk_google_map_api_key', false ) ? get_option( 'rgmk_google_map_api_key' ) : $args['api_key'];
-
-		if($args['type']=='image'){
-			$output .= "<img src='https://maps.googleapis.com/maps/api/staticmap?center=".esc_attr($args['location'])."&maptype=".esc_attr($args['maptype'])."&zoom=".esc_attr($args['zoom'])."&size=".esc_attr($args['static_width'])."x".esc_attr($args['static_height'])."&key=".esc_attr($args['api_key'])."' />";
-		}else{
-			$output .= "<iframe width='".esc_attr($args['width'])."' height='".esc_attr($args['height'])."' frameborder='0' allowfullscreen style='border:0;' src='https://www.google.com/maps/embed/v1/".esc_attr($args['type'])."?q=".esc_attr($args['location'])."&maptype=".esc_attr($args['maptype'])."&zoom=".esc_attr($args['zoom'])."&key=".esc_attr($args['api_key'])."' ></iframe> ";
-		}
-
-		return $output;
-
-	}
+                    ),
+                    'desc_tip' => true,
+                    'default'  => 'roadmap',
+                    'advanced' => true
+                ),
+                'zoom'             => array(
+                    'type'        => 'select',
+                    'title'       => __( 'Zoom level:', 'ayecode-connect' ),
+                    'desc'        => __( 'This is the zoom level of the map, `auto` is recommended.', 'ayecode-connect' ),
+                    'options'     => range( 1, 19 ),
+                    'placeholder' => '',
+                    'desc_tip'    => true,
+                    'default'     => '7',
+                    'advanced'    => true
+                ),
+                'api_key'           => array(
+                    'type'        => 'text',
+                    'title'       => __( 'Api Key:', 'ayecode-connect' ),
+                    'desc'        => __( 'This is the height of the map, you can use %, px or vh here.', 'ayecode-connect' ),
+                    'placeholder' => '',
+                    'desc_tip'    => true,
+                    'default'     => '',
+                    'element_require' => get_option( 'rgmk_google_map_api_key', false) ? '1==0' : '1==1',
+                    'advanced'    => false
+                ),
+            )
+        );
+
+        parent::__construct( $options );
+    }
+
+
+    /**
+     * This is the output function for the widget, shortcode and block (front end).
+     *
+     * @param array $args The arguments values.
+     * @param array $widget_args The widget arguments when used.
+     * @param string $content The shortcode content argument
+     *
+     * @return string
+     */
+    public function output( $args = array(), $widget_args = array(), $content = '' ) {
+
+        // options
+        $defaults = array(
+            'type'      => 'image', // image, place
+            'location' => 'Ireland',
+            'static_width' => '600',
+            'static_height' => '400',
+            'width'=> '100%',
+            'height'=> '425px',
+            'maptype'     => 'roadmap',
+            'zoom'     => '7',
+            'api_key'     => 'AIzaSyBK3ZcmK0ljxl5agNyJNQh_G24Thq1btuE',
+        );
+
+        /**
+         * Parse incoming $args into an array and merge it with $defaults
+         */
+        $args = wp_parse_args($args, $defaults );
+
+        $output = '';
+
+
+        // check if we have a global API key
+        $args['api_key'] = get_option( 'rgmk_google_map_api_key', false ) ? get_option( 'rgmk_google_map_api_key' ) : $args['api_key'];
+
+        if($args['type']=='image'){
+            $output .= "<img src='https://maps.googleapis.com/maps/api/staticmap?center=".esc_attr($args['location'])."&maptype=".esc_attr($args['maptype'])."&zoom=".esc_attr($args['zoom'])."&size=".esc_attr($args['static_width'])."x".esc_attr($args['static_height'])."&key=".esc_attr($args['api_key'])."' />";
+        }else{
+            $output .= "<iframe width='".esc_attr($args['width'])."' height='".esc_attr($args['height'])."' frameborder='0' allowfullscreen style='border:0;' src='https://www.google.com/maps/embed/v1/".esc_attr($args['type'])."?q=".esc_attr($args['location'])."&maptype=".esc_attr($args['maptype'])."&zoom=".esc_attr($args['zoom'])."&key=".esc_attr($args['api_key'])."' ></iframe> ";
+        }
+
+        return $output;
+
+    }
 
 }
 
 // register it.
 add_action( 'widgets_init', function () {
-	register_widget( 'SD_Map' );
+    register_widget( 'SD_Map' );
 } );

includes/payments/class-getpaid-checkout.php

Indentation +310 added lines, -310 removed lines

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

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

Indentation +491 added lines, -491 removed lines

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

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

Indentation +679 added lines, -679 removed lines

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

includes/api/class-getpaid-rest-settings-controller.php

Indentation +743 added lines, -743 removed lines

@@ -18,756 +18,756 @@
  */
 class GetPaid_REST_Settings_Controller extends GetPaid_REST_Controller {
 
-	/**
-	 * An array of available settings.
-	 *
-	 * @var string
-	 */
-	protected $settings;
-
-	/**
-	 * Route base.
-	 *
-	 * @var string
-	 */
-	protected $rest_base = 'settings';
-
-	/**
-	 * Registers the routes for the objects of the controller.
-	 *
-	 * @since 2.0.0
-	 *
-	 * @see register_rest_route()
-	 */
-	public function register_namespace_routes( $namespace ) {
-
-		// List all registered tabs.
-		register_rest_route(
-			$namespace,
-			$this->rest_base,
-			array(
-				array(
-					'methods'             => WP_REST_Server::READABLE,
-					'callback'            => array( $this, 'get_tabs' ),
-					'permission_callback' => array( $this, 'get_items_permissions_check' ),
-				),
-				'schema' => '__return_empty_array',
-			)
-		);
-
-		// View/Update a single setting.
-		register_rest_route(
-			$namespace,
-			$this->rest_base . '/setting/(?P<id>[\w-]+)',
-			array(
-				'args'   => array(
-					'id' => array(
-						'description' => __( 'Unique identifier for the setting.', 'invoicing' ),
-						'type'        => 'string',
-						'required'    => true,
-					),
-				),
-				array(
-					'methods'             => WP_REST_Server::READABLE,
-					'callback'            => array( $this, 'get_item' ),
-					'permission_callback' => array( $this, 'get_items_permissions_check' ),
-				),
-				array(
-					'methods'             => WP_REST_Server::EDITABLE,
-					'callback'            => array( $this, 'update_item' ),
-					'permission_callback' => array( $this, 'update_items_permissions_check' ),
-					'args'                => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ),
-				),
-				'schema' => array( $this, 'get_public_item_schema' ),
-			)
-		);
-
-		// List registered sections for a given tab.
-		register_rest_route(
-			$namespace,
-			$this->rest_base . '/(?P<tab>[\w-]+)',
-			array(
-				'args'   => array(
-					'tab' => array(
-						'description' => __( 'Unique identifier for the tab whose sections should be retrieved.', 'invoicing' ),
-						'type'        => 'string',
-						'required'    => true,
-						'enum'        => array_keys( wpinv_get_settings_tabs() ),
-					),
-				),
-				array(
-					'methods'             => WP_REST_Server::READABLE,
-					'callback'            => array( $this, 'get_sections' ),
-					'permission_callback' => array( $this, 'get_items_permissions_check' ),
-				),
-				'schema' => '__return_empty_array',
-			)
-		);
-
-		// List all registered settings for a given tab.
-		register_rest_route(
-			$namespace,
-			$this->rest_base . '/(?P<tab>[\w-]+)/(?P<section>[\w-]+)',
-			array(
-				'args'   => array(
-					'tab'     => array(
-						'description' => __( 'Unique identifier for the tab whose settings should be retrieved.', 'invoicing' ),
-						'type'        => 'string',
-						'required'    => true,
-						'enum'        => array_keys( wpinv_get_settings_tabs() ),
-					),
-					'section' => array(
-						'description' => __( 'The section in the tab whose settings should be retrieved.', 'invoicing' ),
-						'type'        => 'string',
-						'required'    => true,
-					),
-				),
-				array(
-					'methods'             => WP_REST_Server::READABLE,
-					'callback'            => array( $this, 'get_items' ),
-					'permission_callback' => array( $this, 'get_items_permissions_check' ),
-				),
-				'schema' => array( $this, 'get_public_item_schema' ),
-			)
-		); 
-
-		register_rest_route(
-			$namespace,
-			'/' . $this->rest_base . '/batch',
-			array(
-				'args'   => array(
-					'id' => array(
-						'description' => __( 'Setting ID.', 'invoicing' ),
-						'type'        => 'string',
-					),
-				),
-				array(
-					'methods'             => WP_REST_Server::EDITABLE,
-					'callback'            => array( $this, 'batch_items' ),
-					'permission_callback' => array( $this, 'batch_items_permissions_check' ),
-					'args'                => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ),
-				),
-				'schema' => array( $this, 'get_public_batch_schema' ),
-			)
-		);
-
-	}
-
-	/**
-	 * Return all settings.
-	 *
-	 * @since  2.0.0
-	 * @param  WP_REST_Request $request Request data.
-	 * @return WP_Error|WP_REST_Response
-	 */
-	public function get_items( $request ) {
-
-		$settings = $this->get_settings();
-
-		if ( ! isset( $settings[ $request['tab'] ] ) ) {
-			return new WP_Error( 'rest_invalid_tab', __( 'Invalid tab.', 'invoicing' ), array( 'status' => 400 ) );
-		}
-
-		if ( ! isset( $settings[ $request['tab'] ][ $request['section'] ] ) ) {
-			return new WP_Error( 'rest_invalid_section', __( 'Invalid section.', 'invoicing' ), array( 'status' => 400 ) );
-		}
-
-		$settings = $settings[ $request['tab'] ][ $request['section'] ];
-		$prepared = array();
-
-		foreach ( $settings as $setting ) {
-
-			$setting      = $this->sanitize_setting( $setting );
-			$setting_data = $this->prepare_item_for_response( $setting, $request );
-			$setting_data = $this->prepare_response_for_collection( $setting_data );
-
-			if ( $this->is_setting_type_valid( $setting['type'] ) ) {
-				$prepared[]   = $setting_data;
-			}
+    /**
+     * An array of available settings.
+     *
+     * @var string
+     */
+    protected $settings;
+
+    /**
+     * Route base.
+     *
+     * @var string
+     */
+    protected $rest_base = 'settings';
+
+    /**
+     * Registers the routes for the objects of the controller.
+     *
+     * @since 2.0.0
+     *
+     * @see register_rest_route()
+     */
+    public function register_namespace_routes( $namespace ) {
+
+        // List all registered tabs.
+        register_rest_route(
+            $namespace,
+            $this->rest_base,
+            array(
+                array(
+                    'methods'             => WP_REST_Server::READABLE,
+                    'callback'            => array( $this, 'get_tabs' ),
+                    'permission_callback' => array( $this, 'get_items_permissions_check' ),
+                ),
+                'schema' => '__return_empty_array',
+            )
+        );
+
+        // View/Update a single setting.
+        register_rest_route(
+            $namespace,
+            $this->rest_base . '/setting/(?P<id>[\w-]+)',
+            array(
+                'args'   => array(
+                    'id' => array(
+                        'description' => __( 'Unique identifier for the setting.', 'invoicing' ),
+                        'type'        => 'string',
+                        'required'    => true,
+                    ),
+                ),
+                array(
+                    'methods'             => WP_REST_Server::READABLE,
+                    'callback'            => array( $this, 'get_item' ),
+                    'permission_callback' => array( $this, 'get_items_permissions_check' ),
+                ),
+                array(
+                    'methods'             => WP_REST_Server::EDITABLE,
+                    'callback'            => array( $this, 'update_item' ),
+                    'permission_callback' => array( $this, 'update_items_permissions_check' ),
+                    'args'                => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ),
+                ),
+                'schema' => array( $this, 'get_public_item_schema' ),
+            )
+        );
+
+        // List registered sections for a given tab.
+        register_rest_route(
+            $namespace,
+            $this->rest_base . '/(?P<tab>[\w-]+)',
+            array(
+                'args'   => array(
+                    'tab' => array(
+                        'description' => __( 'Unique identifier for the tab whose sections should be retrieved.', 'invoicing' ),
+                        'type'        => 'string',
+                        'required'    => true,
+                        'enum'        => array_keys( wpinv_get_settings_tabs() ),
+                    ),
+                ),
+                array(
+                    'methods'             => WP_REST_Server::READABLE,
+                    'callback'            => array( $this, 'get_sections' ),
+                    'permission_callback' => array( $this, 'get_items_permissions_check' ),
+                ),
+                'schema' => '__return_empty_array',
+            )
+        );
+
+        // List all registered settings for a given tab.
+        register_rest_route(
+            $namespace,
+            $this->rest_base . '/(?P<tab>[\w-]+)/(?P<section>[\w-]+)',
+            array(
+                'args'   => array(
+                    'tab'     => array(
+                        'description' => __( 'Unique identifier for the tab whose settings should be retrieved.', 'invoicing' ),
+                        'type'        => 'string',
+                        'required'    => true,
+                        'enum'        => array_keys( wpinv_get_settings_tabs() ),
+                    ),
+                    'section' => array(
+                        'description' => __( 'The section in the tab whose settings should be retrieved.', 'invoicing' ),
+                        'type'        => 'string',
+                        'required'    => true,
+                    ),
+                ),
+                array(
+                    'methods'             => WP_REST_Server::READABLE,
+                    'callback'            => array( $this, 'get_items' ),
+                    'permission_callback' => array( $this, 'get_items_permissions_check' ),
+                ),
+                'schema' => array( $this, 'get_public_item_schema' ),
+            )
+        ); 
+
+        register_rest_route(
+            $namespace,
+            '/' . $this->rest_base . '/batch',
+            array(
+                'args'   => array(
+                    'id' => array(
+                        'description' => __( 'Setting ID.', 'invoicing' ),
+                        'type'        => 'string',
+                    ),
+                ),
+                array(
+                    'methods'             => WP_REST_Server::EDITABLE,
+                    'callback'            => array( $this, 'batch_items' ),
+                    'permission_callback' => array( $this, 'batch_items_permissions_check' ),
+                    'args'                => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ),
+                ),
+                'schema' => array( $this, 'get_public_batch_schema' ),
+            )
+        );
+
+    }
+
+    /**
+     * Return all settings.
+     *
+     * @since  2.0.0
+     * @param  WP_REST_Request $request Request data.
+     * @return WP_Error|WP_REST_Response
+     */
+    public function get_items( $request ) {
+
+        $settings = $this->get_settings();
+
+        if ( ! isset( $settings[ $request['tab'] ] ) ) {
+            return new WP_Error( 'rest_invalid_tab', __( 'Invalid tab.', 'invoicing' ), array( 'status' => 400 ) );
+        }
+
+        if ( ! isset( $settings[ $request['tab'] ][ $request['section'] ] ) ) {
+            return new WP_Error( 'rest_invalid_section', __( 'Invalid section.', 'invoicing' ), array( 'status' => 400 ) );
+        }
+
+        $settings = $settings[ $request['tab'] ][ $request['section'] ];
+        $prepared = array();
+
+        foreach ( $settings as $setting ) {
+
+            $setting      = $this->sanitize_setting( $setting );
+            $setting_data = $this->prepare_item_for_response( $setting, $request );
+            $setting_data = $this->prepare_response_for_collection( $setting_data );
+
+            if ( $this->is_setting_type_valid( $setting['type'] ) ) {
+                $prepared[]   = $setting_data;
+            }
 }
 
-		return rest_ensure_response( $prepared );
-	}
-
-	/**
-	 * Return a single setting.
-	 *
-	 * @since  2.0.0
-	 * @param  WP_REST_Request $request Request data.
-	 * @return WP_Error|WP_REST_Response
-	 */
-	public function get_item( $request ) {
-		$setting  = $this->get_setting( $request['id'] );
-
-		if ( is_wp_error( $setting ) ) {
-			return $setting;
-		}
-
-		$setting  = $this->sanitize_setting( $setting );
-		$response = $this->prepare_item_for_response( $setting, $request );
-		return rest_ensure_response( $response );
-	}
-
-	/**
-	 * Update a single setting.
-	 *
-	 * @since  2.0.0
-	 * @param  WP_REST_Request $request Request data.
-	 * @return WP_Error|WP_REST_Response
-	 */
-	public function update_item( $request ) {
-		$setting = $this->get_setting( $request['id'] );
-
-		if ( is_wp_error( $setting ) ) {
-			return $setting;
-		}
-
-		if ( is_callable( array( $this, 'validate_setting_' . $setting['type'] . '_field' ) ) ) {
-			$value = $this->{'validate_setting_' . $setting['type'] . '_field'}( $request['value'], $setting );
-		} else {
-			$value = $this->validate_setting_text_field( $request['value'], $setting );
-		}
-
-		if ( is_wp_error( $value ) ) {
-			return $value;
-		}
-
-		wpinv_update_option( $request['id'], $value );
-		$setting['value'] = $value;
-		$setting          = $this->sanitize_setting( $setting );
-		$response         = $this->prepare_item_for_response( $setting, $request );
-
-		return rest_ensure_response( $response );
-	}
-
-	/**
-	 * Makes sure the current user has access to READ the settings APIs.
-	 *
-	 * @since  2.0.0
-	 * @param WP_REST_Request $request Full data about the request.
-	 * @return WP_Error|boolean
-	 */
-	public function get_items_permissions_check( $request ) {
-		if ( ! wpinv_current_user_can_manage_invoicing() ) {
-			return new WP_Error( 'rest_cannot_view', __( 'Sorry, you cannot list resources.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) );
-		}
-
-		return true;
-	}
-
-	/**
-	 * Makes sure the current user has access to WRITE the settings APIs.
-	 *
-	 * @since  2.0.0
-	 * @param WP_REST_Request $request Full data about the request.
-	 * @return WP_Error|boolean
-	 */
-	public function update_items_permissions_check( $request ) {
-		if ( ! wpinv_current_user_can_manage_invoicing() ) {
-			return new WP_Error( 'rest_cannot_edit', __( 'Sorry, you cannot edit this resource.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) );
-		}
-
-		return true;
-	}
-
-	/**
-	 * Check if a given request has access batch create, update and delete items.
-	 *
-	 * @param  WP_REST_Request $request Full details about the request.
-	 *
-	 * @return boolean|WP_Error
-	 */
-	public function batch_items_permissions_check( $request ) {
-		return wpinv_current_user_can_manage_invoicing() ? true : new WP_Error( 'rest_cannot_batch', __( 'Sorry, you are not allowed to batch manipulate this resource.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) );
-	}
-
-	/**
-	 * Prepare links for the request.
-	 *
-	 * @param string $setting_id Setting ID.
-	 * @return array Links for the given setting.
-	 */
-	protected function prepare_links( $setting_id ) {
-
-		$links = array(
-			'self'       => array(
-				'href' => rest_url( sprintf( '/%s/%s/setting/%s', $this->namespace, $this->rest_base, $setting_id ) ),
-			),
-			'collection' => array(
-				'href' => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ),
-			),
-		);
-
-		return $links;
-	}
-
-	/**
-	 * Prepare a settings object for serialization.
-	 *
-	 * @since  2.0.0
-	 * @param array           $item Setting object.
-	 * @param WP_REST_Request $request Request object.
-	 * @return WP_REST_Response $response Response data.
-	 */
-	public function prepare_item_for_response( $item, $request ) {
-		$context = empty( $request['context'] ) ? 'view' : $request['context'];
-		$data    = $this->add_additional_fields_to_object( $item, $request );
-		$data    = $this->filter_response_by_context( $data, $context );
-
-		$response = rest_ensure_response( $data );
-
-		$response->add_links( $this->prepare_links( $item['id'] ) );
-
-		return $response;
-	}
-
-	/**
-	 * Filters out bad values from the settings array/filter so we
-	 * only return known values via the API.
-	 *
-	 * @since 2.0.0
-	 * @param  array $setting Setting.
-	 * @return array
-	 */
-	public function filter_setting( $setting ) {
-		return array_intersect_key(
-			$setting,
-			array_flip( array_filter( array_keys( $setting ), array( $this, 'allowed_setting_keys' ) ) )
-		);
-	}
-
-	/**
-	 * Callback for allowed keys for each setting response.
-	 *
-	 * @param  string $key Key to check.
-	 * @return boolean
-	 */
-	public function allowed_setting_keys( $key ) {
-		return in_array( $key, array_keys( $this->setting_defaults() ), true );
-	}
-
-	/**
-	 * Returns default options for a setting. null means the field is required.
-	 *
-	 * @since  2.0.0
-	 * @return array
-	 */
-	protected function setting_defaults() {
-		return array(
-			'id'          => null,
-			'name'        => null,
-			'desc'        => '',
-			'options'     => array(),
-			'std'         => false,
-			'value'       => false,
-			'placeholder' => '',
-			'readonly'    => false,
-			'faux'        => false,
-			'section'     => 'main',
-			'tab'         => 'general',
-			'type'        => 'text',
-		);
-	}
-
-	/**
-	 * Sanitizes a setting's field.
-	 *
-	 * @param  array $setting The setting to sanitize.
-	 * @return array
-	 */
-	public function sanitize_setting( $setting ) {
-
-		$setting          = wp_parse_args( $setting, $this->setting_defaults() );
-		$setting['value'] = wpinv_get_option( $setting['id'], $setting['std'] );
-		return $this->filter_setting( $setting );
-
-	}
-
-	/**
-	 * Get setting data.
-	 *
-	 * @since  2.0.0
-	 * @param string $setting_id Setting ID.
-	 * @return array|WP_Error
-	 */
-	public function get_setting( $setting_id ) {
-
-		if ( empty( $setting_id ) ) {
-			return new WP_Error( 'rest_setting_setting_invalid', __( 'Invalid setting.', 'invoicing' ), array( 'status' => 404 ) );
-		}
-
-		$settings  = $this->get_settings();
-
-		foreach ( $settings as $tabs ) {
-
-			foreach ( $tabs as $sections ) {
-
-				if ( isset( $sections[ $setting_id ] ) ) {
-					if ( ! $this->is_setting_type_valid( $sections[ $setting_id ]['type'] ) ) {
-						return new WP_Error( 'rest_setting_setting_type_invalid', __( 'Invalid setting type.', 'invoicing' ), array( 'status' => 404 ) );
-					}
-
-					return $sections[ $setting_id ];
-				}
+        return rest_ensure_response( $prepared );
+    }
+
+    /**
+     * Return a single setting.
+     *
+     * @since  2.0.0
+     * @param  WP_REST_Request $request Request data.
+     * @return WP_Error|WP_REST_Response
+     */
+    public function get_item( $request ) {
+        $setting  = $this->get_setting( $request['id'] );
+
+        if ( is_wp_error( $setting ) ) {
+            return $setting;
+        }
+
+        $setting  = $this->sanitize_setting( $setting );
+        $response = $this->prepare_item_for_response( $setting, $request );
+        return rest_ensure_response( $response );
+    }
+
+    /**
+     * Update a single setting.
+     *
+     * @since  2.0.0
+     * @param  WP_REST_Request $request Request data.
+     * @return WP_Error|WP_REST_Response
+     */
+    public function update_item( $request ) {
+        $setting = $this->get_setting( $request['id'] );
+
+        if ( is_wp_error( $setting ) ) {
+            return $setting;
+        }
+
+        if ( is_callable( array( $this, 'validate_setting_' . $setting['type'] . '_field' ) ) ) {
+            $value = $this->{'validate_setting_' . $setting['type'] . '_field'}( $request['value'], $setting );
+        } else {
+            $value = $this->validate_setting_text_field( $request['value'], $setting );
+        }
+
+        if ( is_wp_error( $value ) ) {
+            return $value;
+        }
+
+        wpinv_update_option( $request['id'], $value );
+        $setting['value'] = $value;
+        $setting          = $this->sanitize_setting( $setting );
+        $response         = $this->prepare_item_for_response( $setting, $request );
+
+        return rest_ensure_response( $response );
+    }
+
+    /**
+     * Makes sure the current user has access to READ the settings APIs.
+     *
+     * @since  2.0.0
+     * @param WP_REST_Request $request Full data about the request.
+     * @return WP_Error|boolean
+     */
+    public function get_items_permissions_check( $request ) {
+        if ( ! wpinv_current_user_can_manage_invoicing() ) {
+            return new WP_Error( 'rest_cannot_view', __( 'Sorry, you cannot list resources.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) );
+        }
+
+        return true;
+    }
+
+    /**
+     * Makes sure the current user has access to WRITE the settings APIs.
+     *
+     * @since  2.0.0
+     * @param WP_REST_Request $request Full data about the request.
+     * @return WP_Error|boolean
+     */
+    public function update_items_permissions_check( $request ) {
+        if ( ! wpinv_current_user_can_manage_invoicing() ) {
+            return new WP_Error( 'rest_cannot_edit', __( 'Sorry, you cannot edit this resource.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) );
+        }
+
+        return true;
+    }
+
+    /**
+     * Check if a given request has access batch create, update and delete items.
+     *
+     * @param  WP_REST_Request $request Full details about the request.
+     *
+     * @return boolean|WP_Error
+     */
+    public function batch_items_permissions_check( $request ) {
+        return wpinv_current_user_can_manage_invoicing() ? true : new WP_Error( 'rest_cannot_batch', __( 'Sorry, you are not allowed to batch manipulate this resource.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) );
+    }
+
+    /**
+     * Prepare links for the request.
+     *
+     * @param string $setting_id Setting ID.
+     * @return array Links for the given setting.
+     */
+    protected function prepare_links( $setting_id ) {
+
+        $links = array(
+            'self'       => array(
+                'href' => rest_url( sprintf( '/%s/%s/setting/%s', $this->namespace, $this->rest_base, $setting_id ) ),
+            ),
+            'collection' => array(
+                'href' => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ),
+            ),
+        );
+
+        return $links;
+    }
+
+    /**
+     * Prepare a settings object for serialization.
+     *
+     * @since  2.0.0
+     * @param array           $item Setting object.
+     * @param WP_REST_Request $request Request object.
+     * @return WP_REST_Response $response Response data.
+     */
+    public function prepare_item_for_response( $item, $request ) {
+        $context = empty( $request['context'] ) ? 'view' : $request['context'];
+        $data    = $this->add_additional_fields_to_object( $item, $request );
+        $data    = $this->filter_response_by_context( $data, $context );
+
+        $response = rest_ensure_response( $data );
+
+        $response->add_links( $this->prepare_links( $item['id'] ) );
+
+        return $response;
+    }
+
+    /**
+     * Filters out bad values from the settings array/filter so we
+     * only return known values via the API.
+     *
+     * @since 2.0.0
+     * @param  array $setting Setting.
+     * @return array
+     */
+    public function filter_setting( $setting ) {
+        return array_intersect_key(
+            $setting,
+            array_flip( array_filter( array_keys( $setting ), array( $this, 'allowed_setting_keys' ) ) )
+        );
+    }
+
+    /**
+     * Callback for allowed keys for each setting response.
+     *
+     * @param  string $key Key to check.
+     * @return boolean
+     */
+    public function allowed_setting_keys( $key ) {
+        return in_array( $key, array_keys( $this->setting_defaults() ), true );
+    }
+
+    /**
+     * Returns default options for a setting. null means the field is required.
+     *
+     * @since  2.0.0
+     * @return array
+     */
+    protected function setting_defaults() {
+        return array(
+            'id'          => null,
+            'name'        => null,
+            'desc'        => '',
+            'options'     => array(),
+            'std'         => false,
+            'value'       => false,
+            'placeholder' => '',
+            'readonly'    => false,
+            'faux'        => false,
+            'section'     => 'main',
+            'tab'         => 'general',
+            'type'        => 'text',
+        );
+    }
+
+    /**
+     * Sanitizes a setting's field.
+     *
+     * @param  array $setting The setting to sanitize.
+     * @return array
+     */
+    public function sanitize_setting( $setting ) {
+
+        $setting          = wp_parse_args( $setting, $this->setting_defaults() );
+        $setting['value'] = wpinv_get_option( $setting['id'], $setting['std'] );
+        return $this->filter_setting( $setting );
+
+    }
+
+    /**
+     * Get setting data.
+     *
+     * @since  2.0.0
+     * @param string $setting_id Setting ID.
+     * @return array|WP_Error
+     */
+    public function get_setting( $setting_id ) {
+
+        if ( empty( $setting_id ) ) {
+            return new WP_Error( 'rest_setting_setting_invalid', __( 'Invalid setting.', 'invoicing' ), array( 'status' => 404 ) );
+        }
+
+        $settings  = $this->get_settings();
+
+        foreach ( $settings as $tabs ) {
+
+            foreach ( $tabs as $sections ) {
+
+                if ( isset( $sections[ $setting_id ] ) ) {
+                    if ( ! $this->is_setting_type_valid( $sections[ $setting_id ]['type'] ) ) {
+                        return new WP_Error( 'rest_setting_setting_type_invalid', __( 'Invalid setting type.', 'invoicing' ), array( 'status' => 404 ) );
+                    }
+
+                    return $sections[ $setting_id ];
+                }
 }
 }
 
-		return new WP_Error( 'rest_setting_setting_invalid', __( 'Invalid setting.', 'invoicing' ), array( 'status' => 404 ) );
-	}
-
-	/**
-	 * Get all tabs.
-	 *
-	 * @param  WP_REST_Request $request Request data.
-	 * @return array
-	 */
-	public function get_tabs( $request ) {
-		$tabs     = wpinv_get_settings_tabs();
-		$prepared = array();
-
-		foreach ( $tabs as $id => $tab ) {
-
-			$_request        = $request;
-			$_request['tab'] = sanitize_title( $id );
-			$data            = array(
-				'id'       => sanitize_title( $id ),
-				'label'    => sanitize_text_field( $tab ),
-				'sections' => $this->get_sections( $_request ),
-			);
-
-			$data     = $this->add_additional_fields_to_object( $data, $request );
-			$response = rest_ensure_response( $data );
-
-			if ( ! is_wp_error( $response ) ) {
-				$links = array(
-					'sections'   => array(
-						'href' => rest_url( sprintf( '/%s/%s/%s', $this->namespace, $this->rest_base, $id ) ),
-					),
-					'collection' => array(
-						'href' => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ),
-					),
-				);
-				$response->add_links( $links );
-				$response = $this->prepare_response_for_collection( $response );
-			}
-
-			$prepared[] = $response;
-
-		}
-
-		return rest_ensure_response( $prepared );
-	}
-
-	/**
-	 * Get all sections.
-	 *
-	 * @param  WP_REST_Request $request Request data.
-	 * @return array
-	 */
-	public function get_sections( $request ) {
-
-		$tab      = sanitize_title( $request['tab'] );
-		$sections = wpinv_get_settings_tab_sections( $tab );
-		$prepared = array();
-
-		foreach ( $sections as $id => $section ) {
-
-			$data            = array(
-				'id'    => sanitize_title( $id ),
-				'label' => sanitize_text_field( $section ),
-			);
-
-			$data     = $this->add_additional_fields_to_object( $data, $request );
-			$response = rest_ensure_response( $data );
-
-			if ( ! is_wp_error( $response ) ) {
-				$links = array(
-					'settings'   => array(
-						'href' => rest_url( sprintf( '/%s/%s/%s/%s', $this->namespace, $this->rest_base, $tab, $id ) ),
-					),
-					'collection' => array(
-						'href' => rest_url( sprintf( '/%s/%s/%s', $this->namespace, $this->rest_base, $tab ) ),
-					),
-					'tabs'       => array(
-						'href' => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ),
-					),
-				);
-				$response->add_links( $links );
-				$response = $this->prepare_response_for_collection( $response );
-			}
-
-			$prepared[] = $response;
-
-		}
-
-		return rest_ensure_response( $prepared );
-	}
-
-	/**
-	 * Get all settings.
-	 *
-	 * @return array
-	 */
-	public function get_settings() {
-
-		if ( empty( $this->settings ) ) {
-			$this->settings = wpinv_get_registered_settings();
-		}
-
-		return $this->settings;
-
-	}
-
-	/**
-	 * Boolean for if a setting type is a valid supported setting type.
-	 *
-	 * @since  2.0.0
-	 * @param  string $type Type.
-	 * @return bool
-	 */
-	public function is_setting_type_valid( $type ) {
-
-		return in_array(
-			$type,
+        return new WP_Error( 'rest_setting_setting_invalid', __( 'Invalid setting.', 'invoicing' ), array( 'status' => 404 ) );
+    }
+
+    /**
+     * Get all tabs.
+     *
+     * @param  WP_REST_Request $request Request data.
+     * @return array
+     */
+    public function get_tabs( $request ) {
+        $tabs     = wpinv_get_settings_tabs();
+        $prepared = array();
+
+        foreach ( $tabs as $id => $tab ) {
+
+            $_request        = $request;
+            $_request['tab'] = sanitize_title( $id );
+            $data            = array(
+                'id'       => sanitize_title( $id ),
+                'label'    => sanitize_text_field( $tab ),
+                'sections' => $this->get_sections( $_request ),
+            );
+
+            $data     = $this->add_additional_fields_to_object( $data, $request );
+            $response = rest_ensure_response( $data );
+
+            if ( ! is_wp_error( $response ) ) {
+                $links = array(
+                    'sections'   => array(
+                        'href' => rest_url( sprintf( '/%s/%s/%s', $this->namespace, $this->rest_base, $id ) ),
+                    ),
+                    'collection' => array(
+                        'href' => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ),
+                    ),
+                );
+                $response->add_links( $links );
+                $response = $this->prepare_response_for_collection( $response );
+            }
+
+            $prepared[] = $response;
+
+        }
+
+        return rest_ensure_response( $prepared );
+    }
+
+    /**
+     * Get all sections.
+     *
+     * @param  WP_REST_Request $request Request data.
+     * @return array
+     */
+    public function get_sections( $request ) {
+
+        $tab      = sanitize_title( $request['tab'] );
+        $sections = wpinv_get_settings_tab_sections( $tab );
+        $prepared = array();
+
+        foreach ( $sections as $id => $section ) {
+
+            $data            = array(
+                'id'    => sanitize_title( $id ),
+                'label' => sanitize_text_field( $section ),
+            );
+
+            $data     = $this->add_additional_fields_to_object( $data, $request );
+            $response = rest_ensure_response( $data );
+
+            if ( ! is_wp_error( $response ) ) {
+                $links = array(
+                    'settings'   => array(
+                        'href' => rest_url( sprintf( '/%s/%s/%s/%s', $this->namespace, $this->rest_base, $tab, $id ) ),
+                    ),
+                    'collection' => array(
+                        'href' => rest_url( sprintf( '/%s/%s/%s', $this->namespace, $this->rest_base, $tab ) ),
+                    ),
+                    'tabs'       => array(
+                        'href' => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ),
+                    ),
+                );
+                $response->add_links( $links );
+                $response = $this->prepare_response_for_collection( $response );
+            }
+
+            $prepared[] = $response;
+
+        }
+
+        return rest_ensure_response( $prepared );
+    }
+
+    /**
+     * Get all settings.
+     *
+     * @return array
+     */
+    public function get_settings() {
+
+        if ( empty( $this->settings ) ) {
+            $this->settings = wpinv_get_registered_settings();
+        }
+
+        return $this->settings;
+
+    }
+
+    /**
+     * Boolean for if a setting type is a valid supported setting type.
+     *
+     * @since  2.0.0
+     * @param  string $type Type.
+     * @return bool
+     */
+    public function is_setting_type_valid( $type ) {
+
+        return in_array(
+            $type,
             array(
-				'text',         // Validates with validate_setting_text_field.
-				'email',        // Validates with validate_setting_text_field.
-				'number',       // Validates with validate_setting_text_field.
-				'color',        // Validates with validate_setting_text_field.
-				'password',     // Validates with validate_setting_text_field.
-				'textarea',     // Validates with validate_setting_textarea_field.
-				'select',       // Validates with validate_setting_select_field.
-				'multiselect',  // Validates with validate_setting_multiselect_field.
-				'radio',        // Validates with validate_setting_radio_field (-> validate_setting_select_field).
-				'checkbox',     // Validates with validate_setting_checkbox_field.
-				'header',       // Validates with validate_setting_text_field.
-			)
-		);
-
-	}
-
-	/**
-	 * Get the settings schema, conforming to JSON Schema.
-	 *
-	 * @return array
-	 */
-	public function get_item_schema() {
-
-		// Maybe retrieve the schema from cache.
-		if ( ! empty( $this->schema ) ) {
-			return $this->add_additional_fields_schema( $this->schema );
-		}
-
-		$schema = array(
-			'$schema'    => 'http://json-schema.org/draft-04/schema#',
-			'title'      => 'setting',
-			'type'       => 'object',
-			'properties' => array(
-				'id'          => array(
-					'description' => __( 'A unique identifier for the setting.', 'invoicing' ),
-					'type'        => 'string',
-					'arg_options' => array(
-						'sanitize_callback' => 'sanitize_title',
-					),
-					'context'     => array( 'view', 'edit' ),
-					'readonly'    => true,
-				),
-				'tab'         => array(
-					'description' => __( 'An identifier for the tab this setting belongs to.', 'invoicing' ),
-					'type'        => 'string',
-					'arg_options' => array(
-						'sanitize_callback' => 'sanitize_title',
-					),
-					'context'     => array( 'view', 'edit' ),
-					'readonly'    => true,
-				),
-				'section'     => array(
-					'description' => __( 'An identifier for the section this setting belongs to.', 'invoicing' ),
-					'type'        => 'string',
-					'arg_options' => array(
-						'sanitize_callback' => 'sanitize_title',
-					),
-					'context'     => array( 'view', 'edit' ),
-					'readonly'    => true,
-				),
-				'name'        => array(
-					'description' => __( 'A human readable label for the setting used in interfaces.', 'invoicing' ),
-					'type'        => 'string',
-					'arg_options' => array(
-						'sanitize_callback' => 'sanitize_text_field',
-					),
-					'context'     => array( 'view', 'edit' ),
-					'readonly'    => true,
-				),
-				'desc'        => array(
-					'description' => __( 'A human readable description for the setting used in interfaces.', 'invoicing' ),
-					'type'        => 'string',
-					'context'     => array( 'view', 'edit' ),
-					'readonly'    => true,
-				),
-				'value'       => array(
-					'description' => __( 'The current value of this setting.', 'invoicing' ),
-					'type'        => 'mixed',
-					'context'     => array( 'view', 'edit' ),
-				),
-				'default'     => array(
-					'description' => __( 'Default value for the setting.', 'invoicing' ),
-					'type'        => 'mixed',
-					'context'     => array( 'view', 'edit' ),
-					'readonly'    => true,
-				),
-				'placeholder' => array(
-					'description' => __( 'Placeholder text to be displayed in text inputs.', 'invoicing' ),
-					'type'        => 'string',
-					'arg_options' => array(
-						'sanitize_callback' => 'sanitize_text_field',
-					),
-					'context'     => array( 'view', 'edit' ),
-					'readonly'    => true,
-				),
-				'type'        => array(
-					'description' => __( 'Type of setting.', 'invoicing' ),
-					'type'        => 'string',
-					'arg_options' => array(
-						'sanitize_callback' => 'sanitize_text_field',
-					),
-					'context'     => array( 'view', 'edit' ),
-					'enum'        => array( 'text', 'email', 'number', 'color', 'password', 'textarea', 'select', 'multiselect', 'radio', 'image_width', 'checkbox', 'raw_html' ),
-					'readonly'    => true,
-				),
-				'options'     => array(
-					'description' => __( 'Array of options (key value pairs) for inputs such as select, multiselect, and radio buttons.', 'invoicing' ),
-					'type'        => 'object',
-					'context'     => array( 'view', 'edit' ),
-					'readonly'    => true,
-				),
-				'readonly'    => array(
-					'description' => __( 'Whether or not this setting is readonly', 'invoicing' ),
-					'type'        => 'string',
-					'context'     => array( 'view' ),
-					'readonly'    => true,
-				),
-				'faux'        => array(
-					'description' => __( 'Whether or not this setting is readonly/faux', 'invoicing' ),
-					'type'        => 'string',
-					'context'     => array( 'view' ),
-					'readonly'    => true,
-				),
-			),
-		);
-
-		// Filters the settings schema for the REST API.
+                'text',         // Validates with validate_setting_text_field.
+                'email',        // Validates with validate_setting_text_field.
+                'number',       // Validates with validate_setting_text_field.
+                'color',        // Validates with validate_setting_text_field.
+                'password',     // Validates with validate_setting_text_field.
+                'textarea',     // Validates with validate_setting_textarea_field.
+                'select',       // Validates with validate_setting_select_field.
+                'multiselect',  // Validates with validate_setting_multiselect_field.
+                'radio',        // Validates with validate_setting_radio_field (-> validate_setting_select_field).
+                'checkbox',     // Validates with validate_setting_checkbox_field.
+                'header',       // Validates with validate_setting_text_field.
+            )
+        );
+
+    }
+
+    /**
+     * Get the settings schema, conforming to JSON Schema.
+     *
+     * @return array
+     */
+    public function get_item_schema() {
+
+        // Maybe retrieve the schema from cache.
+        if ( ! empty( $this->schema ) ) {
+            return $this->add_additional_fields_schema( $this->schema );
+        }
+
+        $schema = array(
+            '$schema'    => 'http://json-schema.org/draft-04/schema#',
+            'title'      => 'setting',
+            'type'       => 'object',
+            'properties' => array(
+                'id'          => array(
+                    'description' => __( 'A unique identifier for the setting.', 'invoicing' ),
+                    'type'        => 'string',
+                    'arg_options' => array(
+                        'sanitize_callback' => 'sanitize_title',
+                    ),
+                    'context'     => array( 'view', 'edit' ),
+                    'readonly'    => true,
+                ),
+                'tab'         => array(
+                    'description' => __( 'An identifier for the tab this setting belongs to.', 'invoicing' ),
+                    'type'        => 'string',
+                    'arg_options' => array(
+                        'sanitize_callback' => 'sanitize_title',
+                    ),
+                    'context'     => array( 'view', 'edit' ),
+                    'readonly'    => true,
+                ),
+                'section'     => array(
+                    'description' => __( 'An identifier for the section this setting belongs to.', 'invoicing' ),
+                    'type'        => 'string',
+                    'arg_options' => array(
+                        'sanitize_callback' => 'sanitize_title',
+                    ),
+                    'context'     => array( 'view', 'edit' ),
+                    'readonly'    => true,
+                ),
+                'name'        => array(
+                    'description' => __( 'A human readable label for the setting used in interfaces.', 'invoicing' ),
+                    'type'        => 'string',
+                    'arg_options' => array(
+                        'sanitize_callback' => 'sanitize_text_field',
+                    ),
+                    'context'     => array( 'view', 'edit' ),
+                    'readonly'    => true,
+                ),
+                'desc'        => array(
+                    'description' => __( 'A human readable description for the setting used in interfaces.', 'invoicing' ),
+                    'type'        => 'string',
+                    'context'     => array( 'view', 'edit' ),
+                    'readonly'    => true,
+                ),
+                'value'       => array(
+                    'description' => __( 'The current value of this setting.', 'invoicing' ),
+                    'type'        => 'mixed',
+                    'context'     => array( 'view', 'edit' ),
+                ),
+                'default'     => array(
+                    'description' => __( 'Default value for the setting.', 'invoicing' ),
+                    'type'        => 'mixed',
+                    'context'     => array( 'view', 'edit' ),
+                    'readonly'    => true,
+                ),
+                'placeholder' => array(
+                    'description' => __( 'Placeholder text to be displayed in text inputs.', 'invoicing' ),
+                    'type'        => 'string',
+                    'arg_options' => array(
+                        'sanitize_callback' => 'sanitize_text_field',
+                    ),
+                    'context'     => array( 'view', 'edit' ),
+                    'readonly'    => true,
+                ),
+                'type'        => array(
+                    'description' => __( 'Type of setting.', 'invoicing' ),
+                    'type'        => 'string',
+                    'arg_options' => array(
+                        'sanitize_callback' => 'sanitize_text_field',
+                    ),
+                    'context'     => array( 'view', 'edit' ),
+                    'enum'        => array( 'text', 'email', 'number', 'color', 'password', 'textarea', 'select', 'multiselect', 'radio', 'image_width', 'checkbox', 'raw_html' ),
+                    'readonly'    => true,
+                ),
+                'options'     => array(
+                    'description' => __( 'Array of options (key value pairs) for inputs such as select, multiselect, and radio buttons.', 'invoicing' ),
+                    'type'        => 'object',
+                    'context'     => array( 'view', 'edit' ),
+                    'readonly'    => true,
+                ),
+                'readonly'    => array(
+                    'description' => __( 'Whether or not this setting is readonly', 'invoicing' ),
+                    'type'        => 'string',
+                    'context'     => array( 'view' ),
+                    'readonly'    => true,
+                ),
+                'faux'        => array(
+                    'description' => __( 'Whether or not this setting is readonly/faux', 'invoicing' ),
+                    'type'        => 'string',
+                    'context'     => array( 'view' ),
+                    'readonly'    => true,
+                ),
+            ),
+        );
+
+        // Filters the settings schema for the REST API.
         $schema = apply_filters( 'getpaid_rest_settings_schema', $schema );
 
-		// Cache the settings schema.
-		$this->schema = $schema;
-
-		return $this->add_additional_fields_schema( $this->schema );
-
-	}
-
-	/**
-	 * Validate a text value for a text based setting.
-	 *
-	 * @since 2.0.0
-	 * @param string $value Value.
-	 * @param array  $setting Setting.
-	 * @return string
-	 */
-	public function validate_setting_text_field( $value ) {
-		$value = is_null( $value ) ? '' : $value;
-		return wp_kses_post( trim( stripslashes( $value ) ) );
-	}
-
-	/**
-	 * Validate select based settings.
-	 *
-	 * @since 2.0.0
-	 * @param string $value Value.
-	 * @param array  $setting Setting.
-	 * @return string|WP_Error
-	 */
-	public function validate_setting_select_field( $value, $setting ) {
-		if ( array_key_exists( $value, $setting['options'] ) ) {
-			return $value;
-		} else {
-			return new WP_Error( 'rest_setting_value_invalid', __( 'An invalid setting value was passed.', 'invoicing' ), array( 'status' => 400 ) );
-		}
-	}
-
-	/**
-	 * Validate multiselect based settings.
-	 *
-	 * @since 2.0.0
-	 * @param array $values Values.
-	 * @param array $setting Setting.
-	 * @return array|WP_Error
-	 */
-	public function validate_setting_multiselect_field( $values, $setting ) {
-		if ( empty( $values ) ) {
-			return array();
-		}
-
-		if ( ! is_array( $values ) ) {
-			return new WP_Error( 'rest_setting_value_invalid', __( 'An invalid setting value was passed.', 'invoicing' ), array( 'status' => 400 ) );
-		}
-
-		$final_values = array();
-		foreach ( $values as $value ) {
-			if ( array_key_exists( $value, $setting['options'] ) ) {
-				$final_values[] = $value;
-			}
-		}
-
-		return $final_values;
-	}
-
-	/**
-	 * Validate radio based settings.
-	 *
-	 * @since 2.0.0
-	 * @param string $value Value.
-	 * @param array  $setting Setting.
-	 * @return string|WP_Error
-	 */
-	public function validate_setting_radio_field( $value, $setting ) {
-		return $this->validate_setting_select_field( $value, $setting );
-	}
-
-	/**
-	 * Validate checkbox based settings.
-	 *
-	 * @since 2.0.0
-	 * @param string $value Value.
-	 * @return int
-	 */
-	public function validate_setting_checkbox_field( $value ) {
-		return (int) ! empty( $value );
-	}
-
-	/**
-	 * Validate textarea based settings.
-	 *
-	 * @since 2.0.0
-	 * @param string $value Value.
-	 * @return string
-	 */
-	public function validate_setting_textarea_field( $value ) {
-		$value = is_null( $value ) ? '' : $value;
-		return wp_kses(
-			trim( stripslashes( $value ) ),
-			array_merge(
-				array(
-					'iframe' => array(
-						'src'   => true,
-						'style' => true,
-						'id'    => true,
-						'class' => true,
-					),
-				),
-				wp_kses_allowed_html( 'post' )
-			)
-		);
-	}
+        // Cache the settings schema.
+        $this->schema = $schema;
+
+        return $this->add_additional_fields_schema( $this->schema );
+
+    }
+
+    /**
+     * Validate a text value for a text based setting.
+     *
+     * @since 2.0.0
+     * @param string $value Value.
+     * @param array  $setting Setting.
+     * @return string
+     */
+    public function validate_setting_text_field( $value ) {
+        $value = is_null( $value ) ? '' : $value;
+        return wp_kses_post( trim( stripslashes( $value ) ) );
+    }
+
+    /**
+     * Validate select based settings.
+     *
+     * @since 2.0.0
+     * @param string $value Value.
+     * @param array  $setting Setting.
+     * @return string|WP_Error
+     */
+    public function validate_setting_select_field( $value, $setting ) {
+        if ( array_key_exists( $value, $setting['options'] ) ) {
+            return $value;
+        } else {
+            return new WP_Error( 'rest_setting_value_invalid', __( 'An invalid setting value was passed.', 'invoicing' ), array( 'status' => 400 ) );
+        }
+    }
+
+    /**
+     * Validate multiselect based settings.
+     *
+     * @since 2.0.0
+     * @param array $values Values.
+     * @param array $setting Setting.
+     * @return array|WP_Error
+     */
+    public function validate_setting_multiselect_field( $values, $setting ) {
+        if ( empty( $values ) ) {
+            return array();
+        }
+
+        if ( ! is_array( $values ) ) {
+            return new WP_Error( 'rest_setting_value_invalid', __( 'An invalid setting value was passed.', 'invoicing' ), array( 'status' => 400 ) );
+        }
+
+        $final_values = array();
+        foreach ( $values as $value ) {
+            if ( array_key_exists( $value, $setting['options'] ) ) {
+                $final_values[] = $value;
+            }
+        }
+
+        return $final_values;
+    }
+
+    /**
+     * Validate radio based settings.
+     *
+     * @since 2.0.0
+     * @param string $value Value.
+     * @param array  $setting Setting.
+     * @return string|WP_Error
+     */
+    public function validate_setting_radio_field( $value, $setting ) {
+        return $this->validate_setting_select_field( $value, $setting );
+    }
+
+    /**
+     * Validate checkbox based settings.
+     *
+     * @since 2.0.0
+     * @param string $value Value.
+     * @return int
+     */
+    public function validate_setting_checkbox_field( $value ) {
+        return (int) ! empty( $value );
+    }
+
+    /**
+     * Validate textarea based settings.
+     *
+     * @since 2.0.0
+     * @param string $value Value.
+     * @return string
+     */
+    public function validate_setting_textarea_field( $value ) {
+        $value = is_null( $value ) ? '' : $value;
+        return wp_kses(
+            trim( stripslashes( $value ) ),
+            array_merge(
+                array(
+                    'iframe' => array(
+                        'src'   => true,
+                        'style' => true,
+                        'id'    => true,
+                        'class' => true,
+                    ),
+                ),
+                wp_kses_allowed_html( 'post' )
+            )
+        );
+    }
 
 }