AyeCode / invoicing

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

Indentation +542 added lines, -542 removed lines

@@ -21,570 +21,570 @@
  */
 class GetPaid_REST_Controller extends WP_REST_Controller {
 
-	/**
+    /**
      * The namespaces of this controller's route.
      *
      * @since 1.0.19
      * @var array
      */
-	protected $namespaces;
+    protected $namespaces;
 
-	/**
+    /**
      * The official namespace of this controller's route.
      *
      * @since 1.0.19
      * @var string
      */
-	protected $namespace = 'getpaid/v1';
+    protected $namespace = 'getpaid/v1';
 
-	/**
+    /**
      * Cached results of get_item_schema.
      *
      * @since 1.0.19
      * @var array
      */
-	protected $schema;
+    protected $schema;
 
     /**
-	 * Constructor.
-	 *
-	 * @since 1.0.19
-	 *
-	 */
-	public function __construct() {
-
-		// Offer several namespaces for backwards compatibility.
-		$this->namespaces = apply_filters(
-			'getpaid_rest_api_namespaces',
-			array(
-				'getpaid/v1',
-				'invoicing/v1',
-				'wpi/v1'
-			)
-		);
-
-		// Register REST routes.
+     * Constructor.
+     *
+     * @since 1.0.19
+     *
+     */
+    public function __construct() {
+
+        // Offer several namespaces for backwards compatibility.
+        $this->namespaces = apply_filters(
+            'getpaid_rest_api_namespaces',
+            array(
+                'getpaid/v1',
+                'invoicing/v1',
+                'wpi/v1'
+            )
+        );
+
+        // Register REST routes.
         add_action( 'rest_api_init', array( $this, 'register_routes' ) );
 
-	}
-
-	/**
-	 * Registers routes for each namespace.
-	 *
-	 * @since 1.0.19
-	 *
-	 */
-	public function register_routes() {
-
-		foreach ( $this->namespaces as $namespace ) {
-			$this->register_namespace_routes( $namespace );
-		}
-
-	}
-
-	/**
-	 * Registers routes for a namespace.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @param string $namespace
-	 */
-	public function register_namespace_routes( /** @scrutinizer ignore-unused */ $namespace ) {
-
-		getpaid_doing_it_wrong(
-			__CLASS__ . '::' .__METHOD__,
-			/* translators: %s: register_namespace_routes() */
-			sprintf( __( "Method '%s' must be overridden." ), __METHOD__ ),
-			'1.0.19'
-		);
-
-	}
-
-	/**
-	 * Get normalized rest base.
-	 *
-	 * @return string
-	 */
-	protected function get_normalized_rest_base() {
-		return preg_replace( '/\(.*\)\//i', '', $this->rest_base );
-	}
-
-	/**
-	 * Fill batches.
-	 *
-	 * @param array array of request items.
-	 * @return array
-	 */
-	protected function fill_batch_keys( $items ) {
-
-		$items['create'] = empty( $items['create'] ) ? array() : $items['create'];
-		$items['update'] = empty( $items['update'] ) ? array() : $items['update'];
-		$items['delete'] = empty( $items['delete'] ) ? array() : wp_parse_id_list( $items['delete'] );
-		return $items;
-
-	}
-
-	/**
-	 * Check batch limit.
-	 *
-	 * @param array $items Request items.
-	 * @return bool|WP_Error
-	 */
-	protected function check_batch_limit( $items ) {
-		$limit = apply_filters( 'getpaid_rest_batch_items_limit', 100, $this->get_normalized_rest_base() );
-		$total = count( $items['create'] ) + count( $items['update'] ) + count( $items['delete'] );
-
-		if ( $total > $limit ) {
-			/* translators: %s: items limit */
-			return new WP_Error( 'getpaid_rest_request_entity_too_large', sprintf( __( 'Unable to accept more than %s items for this request.', 'invoicing' ), $limit ), array( 'status' => 413 ) );
-		}
-
-		return true;
-	}
-
-	/**
-	 * Bulk create items.
-	 *
-	 * @param array $items Array of items to create.
-	 * @param WP_REST_Request $request Full details about the request.
-	 * @param WP_REST_Server $wp_rest_server
-	 * @return array()
-	 */
-	protected function batch_create_items( $items, $request, $wp_rest_server ) {
-
-		$query  = $request->get_query_params();
-		$create = array();
-
-		foreach ( $items as $item ) {
-			$_item = new WP_REST_Request( 'POST' );
-
-			// Default parameters.
-			$defaults = array();
-			$schema   = $this->get_public_item_schema();
-			foreach ( $schema['properties'] as $arg => $options ) {
-				if ( isset( $options['default'] ) ) {
-					$defaults[ $arg ] = $options['default'];
-				}
-			}
-			$_item->set_default_params( $defaults );
-
-			// Set request parameters.
-			$_item->set_body_params( $item );
-
-			// Set query (GET) parameters.
-			$_item->set_query_params( $query );
-
-			// Create the item.
-			$_response = $this->create_item( $_item );
-
-			// If an error occured...
-			if ( is_wp_error( $_response ) ) {
-
-				$create[]   = array(
-					'id'    => 0,
-					'error' => array(
-						'code'    => $_response->get_error_code(),
-						'message' => $_response->get_error_message(),
-						'data'    => $_response->get_error_data(),
-					),
-				);
-
-				continue;
-			}
-
-			$create[] = $wp_rest_server->response_to_data( /** @scrutinizer ignore-type */ $_response, false );
-
-		}
-
-		return $create;
+    }
+
+    /**
+     * Registers routes for each namespace.
+     *
+     * @since 1.0.19
+     *
+     */
+    public function register_routes() {
+
+        foreach ( $this->namespaces as $namespace ) {
+            $this->register_namespace_routes( $namespace );
+        }
+
+    }
+
+    /**
+     * Registers routes for a namespace.
+     *
+     * @since 1.0.19
+     *
+     * @param string $namespace
+     */
+    public function register_namespace_routes( /** @scrutinizer ignore-unused */ $namespace ) {
+
+        getpaid_doing_it_wrong(
+            __CLASS__ . '::' .__METHOD__,
+            /* translators: %s: register_namespace_routes() */
+            sprintf( __( "Method '%s' must be overridden." ), __METHOD__ ),
+            '1.0.19'
+        );
+
+    }
+
+    /**
+     * Get normalized rest base.
+     *
+     * @return string
+     */
+    protected function get_normalized_rest_base() {
+        return preg_replace( '/\(.*\)\//i', '', $this->rest_base );
+    }
+
+    /**
+     * Fill batches.
+     *
+     * @param array array of request items.
+     * @return array
+     */
+    protected function fill_batch_keys( $items ) {
+
+        $items['create'] = empty( $items['create'] ) ? array() : $items['create'];
+        $items['update'] = empty( $items['update'] ) ? array() : $items['update'];
+        $items['delete'] = empty( $items['delete'] ) ? array() : wp_parse_id_list( $items['delete'] );
+        return $items;
+
+    }
+
+    /**
+     * Check batch limit.
+     *
+     * @param array $items Request items.
+     * @return bool|WP_Error
+     */
+    protected function check_batch_limit( $items ) {
+        $limit = apply_filters( 'getpaid_rest_batch_items_limit', 100, $this->get_normalized_rest_base() );
+        $total = count( $items['create'] ) + count( $items['update'] ) + count( $items['delete'] );
+
+        if ( $total > $limit ) {
+            /* translators: %s: items limit */
+            return new WP_Error( 'getpaid_rest_request_entity_too_large', sprintf( __( 'Unable to accept more than %s items for this request.', 'invoicing' ), $limit ), array( 'status' => 413 ) );
+        }
+
+        return true;
+    }
+
+    /**
+     * Bulk create items.
+     *
+     * @param array $items Array of items to create.
+     * @param WP_REST_Request $request Full details about the request.
+     * @param WP_REST_Server $wp_rest_server
+     * @return array()
+     */
+    protected function batch_create_items( $items, $request, $wp_rest_server ) {
+
+        $query  = $request->get_query_params();
+        $create = array();
+
+        foreach ( $items as $item ) {
+            $_item = new WP_REST_Request( 'POST' );
+
+            // Default parameters.
+            $defaults = array();
+            $schema   = $this->get_public_item_schema();
+            foreach ( $schema['properties'] as $arg => $options ) {
+                if ( isset( $options['default'] ) ) {
+                    $defaults[ $arg ] = $options['default'];
+                }
+            }
+            $_item->set_default_params( $defaults );
+
+            // Set request parameters.
+            $_item->set_body_params( $item );
+
+            // Set query (GET) parameters.
+            $_item->set_query_params( $query );
+
+            // Create the item.
+            $_response = $this->create_item( $_item );
+
+            // If an error occured...
+            if ( is_wp_error( $_response ) ) {
+
+                $create[]   = array(
+                    'id'    => 0,
+                    'error' => array(
+                        'code'    => $_response->get_error_code(),
+                        'message' => $_response->get_error_message(),
+                        'data'    => $_response->get_error_data(),
+                    ),
+                );
+
+                continue;
+            }
+
+            $create[] = $wp_rest_server->response_to_data( /** @scrutinizer ignore-type */ $_response, false );
+
+        }
+
+        return $create;
+
+    }
+
+    /**
+     * Bulk update items.
+     *
+     * @param array $items Array of items to update.
+     * @param WP_REST_Request $request Full details about the request.
+     * @param WP_REST_Server $wp_rest_server
+     * @return array()
+     */
+    protected function batch_update_items( $items, $request, $wp_rest_server ) {
+
+        $query  = $request->get_query_params();
+        $update = array();
+
+        foreach ( $items as $item ) {
+
+            // Create a dummy request.
+            $_item = new WP_REST_Request( 'PUT' );
+
+            // Add body params.
+            $_item->set_body_params( $item );
+
+            // Set query (GET) parameters.
+            $_item->set_query_params( $query );
+
+            // Update the item.
+            $_response = $this->update_item( $_item );
+
+            // If an error occured...
+            if ( is_wp_error( $_response ) ) {
+
+                $update[] = array(
+                    'id'    => $item['id'],
+                    'error' => array(
+                        'code'    => $_response->get_error_code(),
+                        'message' => $_response->get_error_message(),
+                        'data'    => $_response->get_error_data(),
+                    ),
+                );
+
+                continue;
+
+            }
+
+            $update[] = $wp_rest_server->response_to_data( /** @scrutinizer ignore-type */ $_response, false );
+
+        }
+
+        return $update;
+
+    }
+
+    /**
+     * Bulk delete items.
+     *
+     * @param array $items Array of items to delete.
+     * @param WP_REST_Server $wp_rest_server
+     * @return array()
+     */
+    protected function batch_delete_items( $items, $wp_rest_server ) {
+
+        $delete = array();
+
+        foreach ( array_filter( $items ) as $id ) {
+
+            // Prepare the request.
+            $_item = new WP_REST_Request( 'DELETE' );
+            $_item->set_query_params(
+                array(
+                    'id'    => $id,
+                    'force' => true,
+                )
+            );
+
+            // Delete the item.
+            $_response = $this->delete_item( $_item );
+
+            if ( is_wp_error( $_response ) ) {
+
+                $delete[] = array(
+                    'id'    => $id,
+                    'error' => array(
+                        'code'    => $_response->get_error_code(),
+                        'message' => $_response->get_error_message(),
+                        'data'    => $_response->get_error_data(),
+                    ),
+                );
+
+                continue;
+            }
 
-	}
-
-	/**
-	 * Bulk update items.
-	 *
-	 * @param array $items Array of items to update.
-	 * @param WP_REST_Request $request Full details about the request.
-	 * @param WP_REST_Server $wp_rest_server
-	 * @return array()
-	 */
-	protected function batch_update_items( $items, $request, $wp_rest_server ) {
-
-		$query  = $request->get_query_params();
-		$update = array();
-
-		foreach ( $items as $item ) {
-
-			// Create a dummy request.
-			$_item = new WP_REST_Request( 'PUT' );
-
-			// Add body params.
-			$_item->set_body_params( $item );
-
-			// Set query (GET) parameters.
-			$_item->set_query_params( $query );
-
-			// Update the item.
-			$_response = $this->update_item( $_item );
-
-			// If an error occured...
-			if ( is_wp_error( $_response ) ) {
-
-				$update[] = array(
-					'id'    => $item['id'],
-					'error' => array(
-						'code'    => $_response->get_error_code(),
-						'message' => $_response->get_error_message(),
-						'data'    => $_response->get_error_data(),
-					),
-				);
-
-				continue;
-
-			}
-
-			$update[] = $wp_rest_server->response_to_data( /** @scrutinizer ignore-type */ $_response, false );
-
-		}
-
-		return $update;
-
-	}
+            $delete[] = $wp_rest_server->response_to_data( /** @scrutinizer ignore-type */ $_response, false );
 
-	/**
-	 * Bulk delete items.
-	 *
-	 * @param array $items Array of items to delete.
-	 * @param WP_REST_Server $wp_rest_server
-	 * @return array()
-	 */
-	protected function batch_delete_items( $items, $wp_rest_server ) {
-
-		$delete = array();
-
-		foreach ( array_filter( $items ) as $id ) {
-
-			// Prepare the request.
-			$_item = new WP_REST_Request( 'DELETE' );
-			$_item->set_query_params(
-				array(
-					'id'    => $id,
-					'force' => true,
-				)
-			);
-
-			// Delete the item.
-			$_response = $this->delete_item( $_item );
-
-			if ( is_wp_error( $_response ) ) {
-
-				$delete[] = array(
-					'id'    => $id,
-					'error' => array(
-						'code'    => $_response->get_error_code(),
-						'message' => $_response->get_error_message(),
-						'data'    => $_response->get_error_data(),
-					),
-				);
-
-				continue;
-			}
-
-			$delete[] = $wp_rest_server->response_to_data( /** @scrutinizer ignore-type */ $_response, false );
-
-		}
-
-		return $delete;
-
-	}
-
-	/**
-	 * Bulk create, update and delete items.
-	 *
-	 * @param WP_REST_Request $request Full details about the request.
-	 * @return WP_Error|array.
-	 */
-	public function batch_items( $request ) {
-		global $wp_rest_server;
-
-		// Prepare the batch items.
-		$items = $this->fill_batch_keys( array_filter( $request->get_params() ) );
-
-		// Ensure that the batch has not exceeded the limit to prevent abuse.
-		$limit = $this->check_batch_limit( $items );
-		if ( is_wp_error( $limit ) ) {
-			return $limit;
-		}
-
-		// Process the items.
-		return array(
-			'create' => $this->batch_create_items( $items['create'], $request, $wp_rest_server ),
-			'update' => $this->batch_update_items( $items['update'], $request, $wp_rest_server ),
-			'delete' => $this->batch_delete_items( $items['delete'], $wp_rest_server ),
-		);
-
-	}
-
-	/**
-	 * Add meta query.
-	 *
-	 * @since 1.0.19
-	 * @param array $args       Query args.
-	 * @param array $meta_query Meta query.
-	 * @return array
-	 */
-	protected function add_meta_query( $args, $meta_query ) {
-		if ( empty( $args['meta_query'] ) ) {
-			$args['meta_query'] = array();
-		}
-
-		$args['meta_query'][] = $meta_query;
-
-		return $args['meta_query'];
-	}
-
-	/**
-	 * Get the batch schema, conforming to JSON Schema.
-	 *
-	 * @return array
-	 */
-	public function get_public_batch_schema() {
-
-		return array(
-			'$schema'    => 'http://json-schema.org/draft-04/schema#',
-			'title'      => 'batch',
-			'type'       => 'object',
-			'properties' => array(
-				'create' => array(
-					'description' => __( 'List of created resources.', 'invoicing' ),
-					'type'        => 'array',
-					'context'     => array( 'view', 'edit' ),
-					'items'       => array(
-						'type'    => 'object',
-					),
-				),
-				'update' => array(
-					'description' => __( 'List of updated resources.', 'invoicing' ),
-					'type'        => 'array',
-					'context'     => array( 'view', 'edit' ),
-					'items'       => array(
-						'type'    => 'object',
-					),
-				),
-				'delete' => array(
-					'description' => __( 'List of deleted resources.', 'invoicing' ),
-					'type'        => 'array',
-					'context'     => array( 'view', 'edit' ),
-					'items'       => array(
-						'type'    => 'integer',
-					),
-				),
-			),
-		);
-
-	}
-
-	/**
-	 * Returns the value of schema['properties']
-	 * 
-	 * i.e Schema fields.
-	 *
-	 * @since 1.0.19
-	 * @return array
-	 */
-	protected function get_schema_properties() {
-
-		$schema     = $this->get_item_schema();
-		$properties = isset( $schema['properties'] ) ? $schema['properties'] : array();
-
-		// For back-compat, include any field with an empty schema
-		// because it won't be present in $this->get_item_schema().
-		foreach ( $this->get_additional_fields() as $field_name => $field_options ) {
-			if ( is_null( $field_options['schema'] ) ) {
-				$properties[ $field_name ] = $field_options;
-			}
-		}
-
-		return $properties;
-	}
-
-	/**
-	 * Filters fields by context.
-	 *
-	 * @param array $fields Array of fields
-	 * @param string|null context view, edit or embed
-	 * @since 1.0.19
-	 * @return array
-	 */
-	protected function filter_response_fields_by_context( $fields, $context ) {
-
-		if ( empty( $context ) ) {
-			return $fields;
-		}
-
-		foreach ( $fields as $name => $options ) {
-			if ( ! empty( $options['context'] ) && ! in_array( $context, $options['context'], true ) ) {
-				unset( $fields[ $name ] );
-			}
-		}
-
-		return $fields;
-
-	}
-
-	/**
-	 * Filters fields by an array of requested fields.
-	 *
-	 * @param array $fields Array of available fields
-	 * @param array $requested array of requested fields.
-	 * @since 1.0.19
-	 * @return array
-	 */
-	protected function filter_response_fields_by_array( $fields, $requested ) {
-
-		// Trim off any whitespace from the list array.
-		$requested = array_map( 'trim', $requested );
-
-		// Always persist 'id', because it can be needed for add_additional_fields_to_object().
-		if ( in_array( 'id', $fields, true ) ) {
-			$requested[] = 'id';
-		}
-
-		// Get rid of duplicate fields.
-		$requested = array_unique( $requested );
-
-		// Return the list of all included fields which are available.
-		return array_reduce(
-			$requested,
-			function( $response_fields, $field ) use ( $fields ) {
-
-				if ( in_array( $field, $fields, true ) ) {
-					$response_fields[] = $field;
-					return $response_fields;
-				}
-
-				// Check for nested fields if $field is not a direct match.
-				$nested_fields = explode( '.', $field );
-
-				// A nested field is included so long as its top-level property is
-				// present in the schema.
-				if ( in_array( $nested_fields[0], $fields, true ) ) {
-					$response_fields[] = $field;
-				}
-
-				return $response_fields;
-			},
-			array()
-		);
-
-	}
-
-	/**
-	 * Gets an array of fields to be included on the response.
-	 *
-	 * Included fields are based on item schema and `_fields=` request argument.
-	 * Copied from WordPress 5.3 to support old versions.
-	 *
-	 * @since 1.0.19
-	 * @param WP_REST_Request $request Full details about the request.
-	 * @return array Fields to be included in the response.
-	 */
-	public function get_fields_for_response( $request ) {
-
-		// Retrieve fields in the schema.
-		$properties = $this->get_schema_properties();
-
-		// Exclude fields that specify a different context than the request context.
-		$properties = $this->filter_response_fields_by_context( $properties, $request['context'] );
-
-		// We only need the field keys.
-		$fields = array_keys( $properties );
-
-		// Is the user filtering the response fields??
-		if ( empty( $request['_fields'] ) ) {
-			return $fields;
-		}
-
-		return $this->filter_response_fields_by_array( $fields, wpinv_parse_list( $request['_fields'] ) );
-
-	}
-
-	/**
-	 * Limits an object to the requested fields.
-	 *
-	 * Included fields are based on the `_fields` request argument.
-	 *
-	 * @since 1.0.19
-	 * @param array $data Fields to include in the response.
-	 * @param array $fields Requested fields.
-	 * @return array Fields to be included in the response.
-	 */
-	public function limit_object_to_requested_fields( $data, $fields, $prefix = '' ) {
-
-		// Is the user filtering the response fields??
-		if ( empty( $fields ) ) {
-			return $data;
-		}
-
-		foreach ( $data as $key => $value ) {
-
-			// Numeric arrays.
-			if ( is_numeric( $key ) && is_array( $value ) ) {
-				$data[ $key ] = $this->limit_object_to_requested_fields( $value, $fields, $prefix );
-				continue;
-			}
-
-			// Generate a new prefix.
-			$new_prefix = empty( $prefix ) ? $key : "$prefix.$key";
-
-			// Check if it was requested.
-			if ( ! empty( $key ) && ! $this->is_field_included( $new_prefix, $fields ) ) {
-				unset( $data[ $key ] );
-				continue;
-			}
-
-			if ( $key != 'meta_data' && is_array( $value ) ) {
-				$data[ $key ] = $this->limit_object_to_requested_fields( $value, $fields, $new_prefix );
-			}
-
-		}
-
-		return $data;
-	}
-
-	/**
-	 * Given an array of fields to include in a response, some of which may be
-	 * `nested.fields`, determine whether the provided field should be included
-	 * in the response body.
-	 *
-	 * Copied from WordPress 5.3 to support old versions.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @param string $field  A field to test for inclusion in the response body.
-	 * @param array  $fields An array of string fields supported by the endpoint.
-	 * @return bool Whether to include the field or not.
-	 * @see rest_is_field_included()
-	 */
-	public function is_field_included( $field, $fields ) {
-		if ( in_array( $field, $fields, true ) ) {
-			return true;
-		}
-
-		foreach ( $fields as $accepted_field ) {
-			// Check to see if $field is the parent of any item in $fields.
-			// A field "parent" should be accepted if "parent.child" is accepted.
-			if ( strpos( $accepted_field, "$field." ) === 0 ) {
-				return true;
-			}
-			// Conversely, if "parent" is accepted, all "parent.child" fields
-			// should also be accepted.
-			if ( strpos( $field, "$accepted_field." ) === 0 ) {
-				return true;
-			}
-		}
-
-		return false;
-	}
+        }
+
+        return $delete;
+
+    }
+
+    /**
+     * Bulk create, update and delete items.
+     *
+     * @param WP_REST_Request $request Full details about the request.
+     * @return WP_Error|array.
+     */
+    public function batch_items( $request ) {
+        global $wp_rest_server;
+
+        // Prepare the batch items.
+        $items = $this->fill_batch_keys( array_filter( $request->get_params() ) );
+
+        // Ensure that the batch has not exceeded the limit to prevent abuse.
+        $limit = $this->check_batch_limit( $items );
+        if ( is_wp_error( $limit ) ) {
+            return $limit;
+        }
+
+        // Process the items.
+        return array(
+            'create' => $this->batch_create_items( $items['create'], $request, $wp_rest_server ),
+            'update' => $this->batch_update_items( $items['update'], $request, $wp_rest_server ),
+            'delete' => $this->batch_delete_items( $items['delete'], $wp_rest_server ),
+        );
+
+    }
+
+    /**
+     * Add meta query.
+     *
+     * @since 1.0.19
+     * @param array $args       Query args.
+     * @param array $meta_query Meta query.
+     * @return array
+     */
+    protected function add_meta_query( $args, $meta_query ) {
+        if ( empty( $args['meta_query'] ) ) {
+            $args['meta_query'] = array();
+        }
+
+        $args['meta_query'][] = $meta_query;
+
+        return $args['meta_query'];
+    }
+
+    /**
+     * Get the batch schema, conforming to JSON Schema.
+     *
+     * @return array
+     */
+    public function get_public_batch_schema() {
+
+        return array(
+            '$schema'    => 'http://json-schema.org/draft-04/schema#',
+            'title'      => 'batch',
+            'type'       => 'object',
+            'properties' => array(
+                'create' => array(
+                    'description' => __( 'List of created resources.', 'invoicing' ),
+                    'type'        => 'array',
+                    'context'     => array( 'view', 'edit' ),
+                    'items'       => array(
+                        'type'    => 'object',
+                    ),
+                ),
+                'update' => array(
+                    'description' => __( 'List of updated resources.', 'invoicing' ),
+                    'type'        => 'array',
+                    'context'     => array( 'view', 'edit' ),
+                    'items'       => array(
+                        'type'    => 'object',
+                    ),
+                ),
+                'delete' => array(
+                    'description' => __( 'List of deleted resources.', 'invoicing' ),
+                    'type'        => 'array',
+                    'context'     => array( 'view', 'edit' ),
+                    'items'       => array(
+                        'type'    => 'integer',
+                    ),
+                ),
+            ),
+        );
+
+    }
+
+    /**
+     * Returns the value of schema['properties']
+     * 
+     * i.e Schema fields.
+     *
+     * @since 1.0.19
+     * @return array
+     */
+    protected function get_schema_properties() {
+
+        $schema     = $this->get_item_schema();
+        $properties = isset( $schema['properties'] ) ? $schema['properties'] : array();
+
+        // For back-compat, include any field with an empty schema
+        // because it won't be present in $this->get_item_schema().
+        foreach ( $this->get_additional_fields() as $field_name => $field_options ) {
+            if ( is_null( $field_options['schema'] ) ) {
+                $properties[ $field_name ] = $field_options;
+            }
+        }
+
+        return $properties;
+    }
+
+    /**
+     * Filters fields by context.
+     *
+     * @param array $fields Array of fields
+     * @param string|null context view, edit or embed
+     * @since 1.0.19
+     * @return array
+     */
+    protected function filter_response_fields_by_context( $fields, $context ) {
+
+        if ( empty( $context ) ) {
+            return $fields;
+        }
+
+        foreach ( $fields as $name => $options ) {
+            if ( ! empty( $options['context'] ) && ! in_array( $context, $options['context'], true ) ) {
+                unset( $fields[ $name ] );
+            }
+        }
+
+        return $fields;
+
+    }
+
+    /**
+     * Filters fields by an array of requested fields.
+     *
+     * @param array $fields Array of available fields
+     * @param array $requested array of requested fields.
+     * @since 1.0.19
+     * @return array
+     */
+    protected function filter_response_fields_by_array( $fields, $requested ) {
+
+        // Trim off any whitespace from the list array.
+        $requested = array_map( 'trim', $requested );
+
+        // Always persist 'id', because it can be needed for add_additional_fields_to_object().
+        if ( in_array( 'id', $fields, true ) ) {
+            $requested[] = 'id';
+        }
+
+        // Get rid of duplicate fields.
+        $requested = array_unique( $requested );
+
+        // Return the list of all included fields which are available.
+        return array_reduce(
+            $requested,
+            function( $response_fields, $field ) use ( $fields ) {
+
+                if ( in_array( $field, $fields, true ) ) {
+                    $response_fields[] = $field;
+                    return $response_fields;
+                }
+
+                // Check for nested fields if $field is not a direct match.
+                $nested_fields = explode( '.', $field );
+
+                // A nested field is included so long as its top-level property is
+                // present in the schema.
+                if ( in_array( $nested_fields[0], $fields, true ) ) {
+                    $response_fields[] = $field;
+                }
+
+                return $response_fields;
+            },
+            array()
+        );
+
+    }
+
+    /**
+     * Gets an array of fields to be included on the response.
+     *
+     * Included fields are based on item schema and `_fields=` request argument.
+     * Copied from WordPress 5.3 to support old versions.
+     *
+     * @since 1.0.19
+     * @param WP_REST_Request $request Full details about the request.
+     * @return array Fields to be included in the response.
+     */
+    public function get_fields_for_response( $request ) {
+
+        // Retrieve fields in the schema.
+        $properties = $this->get_schema_properties();
+
+        // Exclude fields that specify a different context than the request context.
+        $properties = $this->filter_response_fields_by_context( $properties, $request['context'] );
+
+        // We only need the field keys.
+        $fields = array_keys( $properties );
+
+        // Is the user filtering the response fields??
+        if ( empty( $request['_fields'] ) ) {
+            return $fields;
+        }
+
+        return $this->filter_response_fields_by_array( $fields, wpinv_parse_list( $request['_fields'] ) );
+
+    }
+
+    /**
+     * Limits an object to the requested fields.
+     *
+     * Included fields are based on the `_fields` request argument.
+     *
+     * @since 1.0.19
+     * @param array $data Fields to include in the response.
+     * @param array $fields Requested fields.
+     * @return array Fields to be included in the response.
+     */
+    public function limit_object_to_requested_fields( $data, $fields, $prefix = '' ) {
+
+        // Is the user filtering the response fields??
+        if ( empty( $fields ) ) {
+            return $data;
+        }
+
+        foreach ( $data as $key => $value ) {
+
+            // Numeric arrays.
+            if ( is_numeric( $key ) && is_array( $value ) ) {
+                $data[ $key ] = $this->limit_object_to_requested_fields( $value, $fields, $prefix );
+                continue;
+            }
+
+            // Generate a new prefix.
+            $new_prefix = empty( $prefix ) ? $key : "$prefix.$key";
+
+            // Check if it was requested.
+            if ( ! empty( $key ) && ! $this->is_field_included( $new_prefix, $fields ) ) {
+                unset( $data[ $key ] );
+                continue;
+            }
+
+            if ( $key != 'meta_data' && is_array( $value ) ) {
+                $data[ $key ] = $this->limit_object_to_requested_fields( $value, $fields, $new_prefix );
+            }
+
+        }
+
+        return $data;
+    }
+
+    /**
+     * Given an array of fields to include in a response, some of which may be
+     * `nested.fields`, determine whether the provided field should be included
+     * in the response body.
+     *
+     * Copied from WordPress 5.3 to support old versions.
+     *
+     * @since 1.0.19
+     *
+     * @param string $field  A field to test for inclusion in the response body.
+     * @param array  $fields An array of string fields supported by the endpoint.
+     * @return bool Whether to include the field or not.
+     * @see rest_is_field_included()
+     */
+    public function is_field_included( $field, $fields ) {
+        if ( in_array( $field, $fields, true ) ) {
+            return true;
+        }
+
+        foreach ( $fields as $accepted_field ) {
+            // Check to see if $field is the parent of any item in $fields.
+            // A field "parent" should be accepted if "parent.child" is accepted.
+            if ( strpos( $accepted_field, "$field." ) === 0 ) {
+                return true;
+            }
+            // Conversely, if "parent" is accepted, all "parent.child" fields
+            // should also be accepted.
+            if ( strpos( $field, "$accepted_field." ) === 0 ) {
+                return true;
+            }
+        }
+
+        return false;
+    }
 
 }

includes/api/class-wpinv-rest-invoice-controller.php

Indentation +129 added lines, -129 removed lines

@@ -15,136 +15,136 @@
 class WPInv_REST_Invoice_Controller extends GetPaid_REST_Posts_Controller {
 
     /**
-	 * Post type.
-	 *
-	 * @var string
-	 */
-	protected $post_type = 'wpi_invoice';
-
-	/**
-	 * The base of this controller's route.
-	 *
-	 * @since 1.0.13
-	 * @var string
-	 */
-	protected $rest_base = 'invoices';
-
-	/** Contains this controller's class name.
-	 *
-	 * @var string
-	 */
-	public $crud_class = 'WPInv_Invoice';
+     * Post type.
+     *
+     * @var string
+     */
+    protected $post_type = 'wpi_invoice';
 
     /**
-	 * Retrieves the query params for the invoices collection.
-	 *
-	 * @since 1.0.13
-	 *
-	 * @return array Collection parameters.
-	 */
-	public function get_collection_params() {
-
-		$params = array_merge(
-
-			parent::get_collection_params(),
-
-			array(
-
-
-				'customers' => array(
-					'description'       => __( 'Limit result set to invoices for specific user ids.', 'invoicing' ),
-					'type'              => 'array',
-					'items'             => array(
-						'type'          => 'integer',
-					),
-					'default'           => array(),
-					'sanitize_callback' => 'wp_parse_id_list',
-				),
-
-				'exclude_customers'  	=> array(
-					'description' 		=> __( 'Exclude invoices to specific users.', 'invoicing' ),
-					'type'        		=> 'array',
-					'items'       		=> array(
-						'type'          => 'integer',
-					),
-					'default'     		=> array(),
-					'sanitize_callback' => 'wp_parse_id_list',
-				),
-
-				'parent'  	            => array(
-					'description'       => __( 'Limit result set to those of particular parent IDs.', 'invoicing' ),
-					'type'              => 'array',
-					'items'             => array(
-						'type'          => 'integer',
-					),
-					'sanitize_callback' => 'wp_parse_id_list',
-					'default'           => array(),
-				),
-
-				'parent_exclude'  	    => array(
-					'description'       => __( 'Limit result set to all items except those of a particular parent ID.', 'invoicing' ),
-					'type'              => 'array',
-					'items'             => array(
-						'type'          => 'integer',
-					),
-					'sanitize_callback' => 'wp_parse_id_list',
-					'default'           => array(),
-				),
-
-			)
-
-		);
-
-		// Filter collection parameters for the invoices controller.
-		return apply_filters( 'getpaid_rest_invoices_collection_params', $params, $this );
-	}
-
-	/**
-	 * Determine the allowed query_vars for a get_items() response and
-	 * prepare for WP_Query.
-	 *
-	 * @param array           $prepared_args Prepared arguments.
-	 * @param WP_REST_Request $request Request object.
-	 * @return array          $query_args
-	 */
-	protected function prepare_items_query( $prepared_args = array(), $request = null ) {
-
-		$query_args = parent::prepare_items_query( $prepared_args );
-
-		// Retrieve invoices for specific customers.
-		if ( ! empty( $request['customers'] ) ) {
-			$query_args['author__in'] = $request['customers'];
-		}
-
-		// Skip invoices for specific customers.
-		if ( ! empty( $request['exclude_customers'] ) ) {
-			$query_args['author__not_in'] = $request['exclude_customers'];
-		}
-
-		return apply_filters( 'getpaid_rest_invoices_prepare_items_query', $query_args, $request, $this );
-
-	}
-
-	/**
-	 * Retrieves a valid list of post statuses.
-	 *
-	 * @since 1.0.15
-	 *
-	 * @return array A list of registered item statuses.
-	 */
-	public function get_post_statuses() {
-		return array_keys( wpinv_get_invoice_statuses( true ) );
-	}
-
-	/**
-	 * Saves a single invoice.
-	 *
-	 * @param WPInv_Invoice $invoice Invoice to save.
-	 * @return WP_Error|WPInv_Invoice
-	 */
-	protected function save_object( $invoice ) {
-		$invoice->recalculate_total();
-		return parent::save_object( $invoice );
-	}
+     * The base of this controller's route.
+     *
+     * @since 1.0.13
+     * @var string
+     */
+    protected $rest_base = 'invoices';
+
+    /** Contains this controller's class name.
+     *
+     * @var string
+     */
+    public $crud_class = 'WPInv_Invoice';
+
+    /**
+     * Retrieves the query params for the invoices collection.
+     *
+     * @since 1.0.13
+     *
+     * @return array Collection parameters.
+     */
+    public function get_collection_params() {
+
+        $params = array_merge(
+
+            parent::get_collection_params(),
+
+            array(
+
+
+                'customers' => array(
+                    'description'       => __( 'Limit result set to invoices for specific user ids.', 'invoicing' ),
+                    'type'              => 'array',
+                    'items'             => array(
+                        'type'          => 'integer',
+                    ),
+                    'default'           => array(),
+                    'sanitize_callback' => 'wp_parse_id_list',
+                ),
+
+                'exclude_customers'  	=> array(
+                    'description' 		=> __( 'Exclude invoices to specific users.', 'invoicing' ),
+                    'type'        		=> 'array',
+                    'items'       		=> array(
+                        'type'          => 'integer',
+                    ),
+                    'default'     		=> array(),
+                    'sanitize_callback' => 'wp_parse_id_list',
+                ),
+
+                'parent'  	            => array(
+                    'description'       => __( 'Limit result set to those of particular parent IDs.', 'invoicing' ),
+                    'type'              => 'array',
+                    'items'             => array(
+                        'type'          => 'integer',
+                    ),
+                    'sanitize_callback' => 'wp_parse_id_list',
+                    'default'           => array(),
+                ),
+
+                'parent_exclude'  	    => array(
+                    'description'       => __( 'Limit result set to all items except those of a particular parent ID.', 'invoicing' ),
+                    'type'              => 'array',
+                    'items'             => array(
+                        'type'          => 'integer',
+                    ),
+                    'sanitize_callback' => 'wp_parse_id_list',
+                    'default'           => array(),
+                ),
+
+            )
+
+        );
+
+        // Filter collection parameters for the invoices controller.
+        return apply_filters( 'getpaid_rest_invoices_collection_params', $params, $this );
+    }
+
+    /**
+     * Determine the allowed query_vars for a get_items() response and
+     * prepare for WP_Query.
+     *
+     * @param array           $prepared_args Prepared arguments.
+     * @param WP_REST_Request $request Request object.
+     * @return array          $query_args
+     */
+    protected function prepare_items_query( $prepared_args = array(), $request = null ) {
+
+        $query_args = parent::prepare_items_query( $prepared_args );
+
+        // Retrieve invoices for specific customers.
+        if ( ! empty( $request['customers'] ) ) {
+            $query_args['author__in'] = $request['customers'];
+        }
+
+        // Skip invoices for specific customers.
+        if ( ! empty( $request['exclude_customers'] ) ) {
+            $query_args['author__not_in'] = $request['exclude_customers'];
+        }
+
+        return apply_filters( 'getpaid_rest_invoices_prepare_items_query', $query_args, $request, $this );
+
+    }
+
+    /**
+     * Retrieves a valid list of post statuses.
+     *
+     * @since 1.0.15
+     *
+     * @return array A list of registered item statuses.
+     */
+    public function get_post_statuses() {
+        return array_keys( wpinv_get_invoice_statuses( true ) );
+    }
+
+    /**
+     * Saves a single invoice.
+     *
+     * @param WPInv_Invoice $invoice Invoice to save.
+     * @return WP_Error|WPInv_Invoice
+     */
+    protected function save_object( $invoice ) {
+        $invoice->recalculate_total();
+        return parent::save_object( $invoice );
+    }
 
 }

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

Indentation +619 added lines, -619 removed lines

@@ -18,628 +18,628 @@
 class GetPaid_REST_Posts_Controller extends GetPaid_REST_CRUD_Controller {
 
     /**
-	 * Post type.
-	 *
-	 * @var string
-	 */
-	protected $post_type;
-
-	/**
-	 * Controls visibility on frontend.
-	 *
-	 * @var string
-	 */
-	public $public = false;
-
-	/**
-	 * Registers the routes for the objects of the controller.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @see register_rest_route()
-	 */
-	public function register_namespace_routes( $namespace ) {
-
-		parent::register_namespace_routes( $namespace );
-
-		register_rest_route(
-			$namespace,
-			'/' . $this->rest_base . '/batch',
-			array(
-				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' ),
-			)
-		);
-
-	}
-
-	/**
-	 * Check permissions of items on REST API.
-	 *
-	 * @since 1.0.19
-	 * @param string $context   Request context.
-	 * @param int    $object_id Post ID.
-	 * @return bool
-	 */
-	public function check_post_permissions( $context = 'read', $object_id = 0 ) {
-
-		$contexts = array(
-			'read'   => 'read_private_posts',
-			'create' => 'publish_posts',
-			'edit'   => 'edit_post',
-			'delete' => 'delete_post',
-			'batch'  => 'edit_others_posts',
-		);
-
-		$cap              = $contexts[ $context ];
-		$post_type_object = get_post_type_object( $this->post_type );
-		$permission       = current_user_can( $post_type_object->cap->$cap, $object_id );
-
-		return apply_filters( 'getpaid_rest_check_permissions', $permission, $context, $object_id, $this->post_type );
-	}
-
-	/**
-	 * Check if a given request has access to read items.
-	 *
-	 * @param  WP_REST_Request $request Full details about the request.
-	 * @return WP_Error|boolean
-	 */
-	public function get_items_permissions_check( $request ) {
-		return $this->check_post_permissions() ? true : new WP_Error( 'rest_cannot_view', __( 'Sorry, you cannot list resources.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) );
-	}
-
-	/**
-	 * Check if a given request has access to create an item.
-	 *
-	 * @param  WP_REST_Request $request Full details about the request.
-	 * @return WP_Error|boolean
-	 */
-	public function create_item_permissions_check( $request ) {
-		return $this->check_post_permissions( 'create' ) ? true : new WP_Error( 'rest_cannot_create', __( 'Sorry, you are not allowed to create resources.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) );
-	}
-
-	/**
-	 * Check if a given request has access to read an item.
-	 *
-	 * @param  WP_REST_Request $request Full details about the request.
-	 * @return WP_Error|boolean
-	 */
-	public function get_item_permissions_check( $request ) {
-		$post = get_post( (int) $request['id'] );
-
-		if ( $post && ! $this->check_post_permissions( 'read', $post->ID ) ) {
-			return new WP_Error( 'rest_cannot_view', __( 'Sorry, you cannot view this resource.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) );
-		}
-
-		return true;
-	}
-
-	/**
-	 * Check if a given request has access to update an item.
-	 *
-	 * @param  WP_REST_Request $request Full details about the request.
-	 * @return WP_Error|boolean
-	 */
-	public function update_item_permissions_check( $request ) {
-		$post = get_post( (int) $request['id'] );
-
-		if ( $post && ! $this->check_post_permissions( 'edit', $post->ID ) ) {
-			return new WP_Error( 'rest_cannot_edit', __( 'Sorry, you are not allowed to edit this resource.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) );
-		}
-
-		return true;
-	}
-
-	/**
-	 * Check if a given request has access to delete an item.
-	 *
-	 * @param  WP_REST_Request $request Full details about the request.
-	 * @return bool|WP_Error
-	 */
-	public function delete_item_permissions_check( $request ) {
-		$post = get_post( (int) $request['id'] );
-
-		if ( $post && ! $this->check_post_permissions( 'delete', $post->ID ) ) {
-			return new WP_Error( 'rest_cannot_delete', __( 'Sorry, you are not allowed to delete 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 $this->check_post_permissions( 'batch' ) ? true : new WP_Error( 'rest_cannot_batch', __( 'Sorry, you are not allowed to batch manipulate this resource.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) );
-	}
-
-	/**
-	 * @deprecated
-	 */
-	public function get_post( $object_id ) {
-		return $this->get_object( $object_id );
+     * Post type.
+     *
+     * @var string
+     */
+    protected $post_type;
+
+    /**
+     * Controls visibility on frontend.
+     *
+     * @var string
+     */
+    public $public = false;
+
+    /**
+     * Registers the routes for the objects of the controller.
+     *
+     * @since 1.0.19
+     *
+     * @see register_rest_route()
+     */
+    public function register_namespace_routes( $namespace ) {
+
+        parent::register_namespace_routes( $namespace );
+
+        register_rest_route(
+            $namespace,
+            '/' . $this->rest_base . '/batch',
+            array(
+                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' ),
+            )
+        );
+
+    }
+
+    /**
+     * Check permissions of items on REST API.
+     *
+     * @since 1.0.19
+     * @param string $context   Request context.
+     * @param int    $object_id Post ID.
+     * @return bool
+     */
+    public function check_post_permissions( $context = 'read', $object_id = 0 ) {
+
+        $contexts = array(
+            'read'   => 'read_private_posts',
+            'create' => 'publish_posts',
+            'edit'   => 'edit_post',
+            'delete' => 'delete_post',
+            'batch'  => 'edit_others_posts',
+        );
+
+        $cap              = $contexts[ $context ];
+        $post_type_object = get_post_type_object( $this->post_type );
+        $permission       = current_user_can( $post_type_object->cap->$cap, $object_id );
+
+        return apply_filters( 'getpaid_rest_check_permissions', $permission, $context, $object_id, $this->post_type );
+    }
+
+    /**
+     * Check if a given request has access to read items.
+     *
+     * @param  WP_REST_Request $request Full details about the request.
+     * @return WP_Error|boolean
+     */
+    public function get_items_permissions_check( $request ) {
+        return $this->check_post_permissions() ? true : new WP_Error( 'rest_cannot_view', __( 'Sorry, you cannot list resources.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) );
+    }
+
+    /**
+     * Check if a given request has access to create an item.
+     *
+     * @param  WP_REST_Request $request Full details about the request.
+     * @return WP_Error|boolean
+     */
+    public function create_item_permissions_check( $request ) {
+        return $this->check_post_permissions( 'create' ) ? true : new WP_Error( 'rest_cannot_create', __( 'Sorry, you are not allowed to create resources.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) );
+    }
+
+    /**
+     * Check if a given request has access to read an item.
+     *
+     * @param  WP_REST_Request $request Full details about the request.
+     * @return WP_Error|boolean
+     */
+    public function get_item_permissions_check( $request ) {
+        $post = get_post( (int) $request['id'] );
+
+        if ( $post && ! $this->check_post_permissions( 'read', $post->ID ) ) {
+            return new WP_Error( 'rest_cannot_view', __( 'Sorry, you cannot view this resource.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) );
+        }
+
+        return true;
+    }
+
+    /**
+     * Check if a given request has access to update an item.
+     *
+     * @param  WP_REST_Request $request Full details about the request.
+     * @return WP_Error|boolean
+     */
+    public function update_item_permissions_check( $request ) {
+        $post = get_post( (int) $request['id'] );
+
+        if ( $post && ! $this->check_post_permissions( 'edit', $post->ID ) ) {
+            return new WP_Error( 'rest_cannot_edit', __( 'Sorry, you are not allowed to edit this resource.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) );
+        }
+
+        return true;
+    }
+
+    /**
+     * Check if a given request has access to delete an item.
+     *
+     * @param  WP_REST_Request $request Full details about the request.
+     * @return bool|WP_Error
+     */
+    public function delete_item_permissions_check( $request ) {
+        $post = get_post( (int) $request['id'] );
+
+        if ( $post && ! $this->check_post_permissions( 'delete', $post->ID ) ) {
+            return new WP_Error( 'rest_cannot_delete', __( 'Sorry, you are not allowed to delete 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 $this->check_post_permissions( 'batch' ) ? true : new WP_Error( 'rest_cannot_batch', __( 'Sorry, you are not allowed to batch manipulate this resource.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) );
+    }
+
+    /**
+     * @deprecated
+     */
+    public function get_post( $object_id ) {
+        return $this->get_object( $object_id );
+    }
+
+    /**
+     * Get a single object.
+     *
+     * @param WP_REST_Request $request Full details about the request.
+     * @return WP_Error|WP_REST_Response
+     */
+    public function get_item( $request ) {
+
+        // Fetch item.
+        $response = parent::get_item( $request );
+
+        // (Maybe) add a link to the html pagee.
+        if ( $this->public && ! is_wp_error( $response ) ) {
+            $response->link_header( 'alternate', get_permalink( $this->data_object->get_id() ), array( 'type' => 'text/html' ) );
+        }
+
+        return $response;
+    }
+
+    /**
+     * Create a single object.
+     *
+     * @param WP_REST_Request $request Full details about the request.
+     * @return WP_Error|WP_REST_Response
+     */
+    public function create_item( $request ) {
+
+        // Create item.
+        $response = parent::create_item( $request );
+
+        // Fire a hook after an item is created.
+        if ( ! is_wp_error( $response ) ) {
+
+            /**
+             * Fires after a single item is created or updated via the REST API.
+             *
+             * @param WP_Post         $post      Post object.
+             * @param WP_REST_Request $request   Request object.
+             * @param boolean         $creating  True when creating item, false when updating.
+             */
+            do_action( "getpaid_rest_insert_{$this->post_type}", $this->data_object, $request, true );
+
+        }
+
+        return $response;
+
     }
 
-	/**
-	 * Get a single object.
-	 *
-	 * @param WP_REST_Request $request Full details about the request.
-	 * @return WP_Error|WP_REST_Response
-	 */
-	public function get_item( $request ) {
-
-		// Fetch item.
-		$response = parent::get_item( $request );
-
-		// (Maybe) add a link to the html pagee.
-		if ( $this->public && ! is_wp_error( $response ) ) {
-			$response->link_header( 'alternate', get_permalink( $this->data_object->get_id() ), array( 'type' => 'text/html' ) );
-		}
-
-		return $response;
-	}
-
-	/**
-	 * Create a single object.
-	 *
-	 * @param WP_REST_Request $request Full details about the request.
-	 * @return WP_Error|WP_REST_Response
-	 */
-	public function create_item( $request ) {
-
-		// Create item.
-		$response = parent::create_item( $request );
-
-		// Fire a hook after an item is created.
-		if ( ! is_wp_error( $response ) ) {
-
-			/**
-			 * Fires after a single item is created or updated via the REST API.
-			 *
-			 * @param WP_Post         $post      Post object.
-			 * @param WP_REST_Request $request   Request object.
-			 * @param boolean         $creating  True when creating item, false when updating.
-			 */
-			do_action( "getpaid_rest_insert_{$this->post_type}", $this->data_object, $request, true );
-
-		}
-
-		return $response;
-
-	}
-
-	/**
-	 * Update a single object.
-	 *
-	 * @param WP_REST_Request $request Full details about the request.
-	 * @return WP_Error|WP_REST_Response
-	 */
-	public function update_item( $request ) {
-
-		// Create item.
-		$response = parent::update_item( $request );
-
-		// Fire a hook after an item is created.
-		if ( ! is_wp_error( $response ) ) {
-
-			/**
-			 * Fires after a single item is created or updated via the REST API.
-			 *
-			 * @param WP_Post         $post      Post object.
-			 * @param WP_REST_Request $request   Request object.
-			 * @param boolean         $creating  True when creating item, false when updating.
-			 */
-			do_action( "getpaid_rest_insert_{$this->post_type}", $this->data_object, $request, false );
-
-		}
-
-		return $response;
-
-	}
-
-	/**
-	 * Get a collection of objects.
-	 *
-	 * @param WP_REST_Request $request Full details about the request.
-	 * @return WP_Error|WP_REST_Response
-	 */
-	public function get_items( $request ) {
-
-		$args                         = array();
-		$args['offset']               = $request['offset'];
-		$args['order']                = $request['order'];
-		$args['orderby']              = $request['orderby'];
-		$args['paged']                = $request['page'];
-		$args['post__in']             = $request['include'];
-		$args['post__not_in']         = $request['exclude'];
-		$args['posts_per_page']       = $request['per_page'];
-		$args['name']                 = $request['slug'];
-		$args['post_parent__in']      = $request['parent'];
-		$args['post_parent__not_in']  = $request['parent_exclude'];
-		$args['s']                    = $request['search'];
-		$args['post_status']          = wpinv_parse_list( $request['status'] );
-
-		$args['date_query'] = array();
-
-		// Set before into date query. Date query must be specified as an array of an array.
-		if ( isset( $request['before'] ) ) {
-			$args['date_query'][0]['before'] = $request['before'];
-		}
-
-		// Set after into date query. Date query must be specified as an array of an array.
-		if ( isset( $request['after'] ) ) {
-			$args['date_query'][0]['after'] = $request['after'];
-		}
-
-		// Force the post_type & fields arguments, since they're not a user input variable.
-		$args['post_type'] = $this->post_type;
-		$args['fields']    = 'ids';
-
-		// Filter the query arguments for a request.
-		$args       = apply_filters( "getpaid_rest_{$this->post_type}_query", $args, $request );
-		$query_args = $this->prepare_items_query( $args, $request );
-
-		$posts_query = new WP_Query();
-		$query_result = $posts_query->query( $query_args );
-
-		$posts = array();
-		foreach ( $query_result as $post_id ) {
-			if ( ! $this->check_post_permissions( 'read', $post_id ) ) {
-				continue;
-			}
-
-			$data    = $this->prepare_item_for_response( $this->get_object( $post_id ), $request );
-			$posts[] = $this->prepare_response_for_collection( $data );
-		}
-
-		$page        = (int) $query_args['paged'];
-		$total_posts = $posts_query->found_posts;
-
-		if ( $total_posts < 1 ) {
-			// Out-of-bounds, run the query again without LIMIT for total count.
-			unset( $query_args['paged'] );
-			$count_query = new WP_Query();
-			$count_query->query( $query_args );
-			$total_posts = $count_query->found_posts;
-		}
-
-		$max_pages = ceil( $total_posts / (int) $query_args['posts_per_page'] );
-
-		$response = rest_ensure_response( $posts );
-		$response->header( 'X-WP-Total', (int) $total_posts );
-		$response->header( 'X-WP-TotalPages', (int) $max_pages );
-
-		$request_params = $request->get_query_params();
-		$base = add_query_arg( $request_params, rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ) );
-
-		if ( $page > 1 ) {
-			$prev_page = $page - 1;
-			if ( $prev_page > $max_pages ) {
-				$prev_page = $max_pages;
-			}
-			$prev_link = add_query_arg( 'page', $prev_page, $base );
-			$response->link_header( 'prev', $prev_link );
-		}
-		if ( $max_pages > $page ) {
-			$next_page = $page + 1;
-			$next_link = add_query_arg( 'page', $next_page, $base );
-			$response->link_header( 'next', $next_link );
-		}
-
-		return $response;
-	}
-
-	/**
-	 * Delete a single item.
-	 *
-	 * @param WP_REST_Request $request Full details about the request.
-	 * @return WP_REST_Response|WP_Error
-	 */
-	public function delete_item( $request ) {
-
-		// Fetch the item.
-		$item = $this->get_object( $request['id'] );
-		if ( is_wp_error( $item ) ) {
-			return $item;
-		}
-
-		$supports_trash = EMPTY_TRASH_DAYS > 0;
-		$force          = $supports_trash && (bool) $request['force'];
-
-		if ( ! $this->check_post_permissions( 'delete', $item->ID ) ) {
-			return new WP_Error( "cannot_delete", __( 'Sorry, you are not allowed to delete this resource.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) );
-		}
-
-		$request->set_param( 'context', 'edit' );
-		$response = $this->prepare_item_for_response( $item, $request );
-
-		if ( ! wp_delete_post( $item->ID, $force ) ) {
-			return new WP_Error( 'rest_cannot_delete', sprintf( __( 'The resource cannot be deleted.', 'invoicing' ), $this->post_type ), array( 'status' => 500 ) );
-		}
-
-		return $response;
-	}
-
-	/**
-	 * Prepare links for the request.
-	 *
-	 * @param GetPaid_Data    $object GetPaid_Data object.
-	 * @return array Links for the given object.
-	 */
-	protected function prepare_links( $object ) {
-
-		$links = parent::prepare_links( $object );
-
-		if ( is_callable( array( $object, 'get_user_id' ) ) ) {
-			$links['user'] = array(
-				'href'       => rest_url( 'wp/v2/users/' . call_user_func(  array( $object, 'get_user_id' )  ) ),
-				'embeddable' => true,
-			);
-		}
-
-		if ( is_callable( array( $object, 'get_owner' ) ) ) {
-			$links['owner']  = array(
-				'href'       => rest_url( 'wp/v2/users/' . call_user_func(  array( $object, 'get_owner' )  ) ),
-				'embeddable' => true,
-			);
-		}
-
-		if ( is_callable( array( $object, 'get_parent_id' ) ) && call_user_func(  array( $object, 'get_parent_id' )  ) ) {
-			$links['parent']  = array(
-				'href'       => rest_url( "$this->namespace/$this->rest_base/" . call_user_func(  array( $object, 'get_parent_id' )  ) ),
-				'embeddable' => true,
-			);
-		}
-
-		return $links;
-	}
-
-	/**
-	 * Determine the allowed query_vars for a get_items() response and
-	 * prepare for WP_Query.
-	 *
-	 * @param array           $prepared_args Prepared arguments.
-	 * @param WP_REST_Request $request Request object.
-	 * @return array          $query_args
-	 */
-	protected function prepare_items_query( $prepared_args = array(), $request = null ) {
-
-		$valid_vars = array_flip( $this->get_allowed_query_vars() );
-		$query_args = array();
-		foreach ( $valid_vars as $var => $index ) {
-			if ( isset( $prepared_args[ $var ] ) ) {
-				$query_args[ $var ] = apply_filters( "getpaid_rest_query_var-{$var}", $prepared_args[ $var ], $index );
-			}
-		}
-
-		$query_args['ignore_sticky_posts'] = true;
-
-		if ( 'include' === $query_args['orderby'] ) {
-			$query_args['orderby'] = 'post__in';
-		} elseif ( 'id' === $query_args['orderby'] ) {
-			$query_args['orderby'] = 'ID'; // ID must be capitalized.
-		} elseif ( 'slug' === $query_args['orderby'] ) {
-			$query_args['orderby'] = 'name';
-		}
-
-		return apply_filters( 'getpaid_rest_prepare_items_query', $query_args, $request, $this );
-
-	}
-
-	/**
-	 * Get all the WP Query vars that are allowed for the API request.
-	 *
-	 * @return array
-	 */
-	protected function get_allowed_query_vars() {
-		global $wp;
-
-		/**
-		 * Filter the publicly allowed query vars.
-		 *
-		 * Allows adjusting of the default query vars that are made public.
-		 *
-		 * @param array  Array of allowed WP_Query query vars.
-		 */
-		$valid_vars = apply_filters( 'query_vars', $wp->public_query_vars );
-
-		$post_type_obj = get_post_type_object( $this->post_type );
-		if ( current_user_can( $post_type_obj->cap->edit_posts ) ) {
-			$private = apply_filters( 'getpaid_rest_private_query_vars', $wp->private_query_vars );
-			$valid_vars = array_merge( $valid_vars, $private );
-		}
-
-		// Define our own in addition to WP's normal vars.
-		$rest_valid = array(
-			'post_status',
-			'date_query',
-			'ignore_sticky_posts',
-			'offset',
-			'post__in',
-			'post__not_in',
-			'post_parent',
-			'post_parent__in',
-			'post_parent__not_in',
-			'posts_per_page',
-			'meta_query',
-			'tax_query',
-			'meta_key',
-			'meta_value',
-			'meta_compare',
-			'meta_value_num',
-		);
-		$valid_vars = array_merge( $valid_vars, $rest_valid );
-
-		// Filter allowed query vars for the REST API.
-		$valid_vars = apply_filters( 'getpaid_rest_query_vars', $valid_vars, $this );
-
-		return $valid_vars;
-	}
-
-	/**
-	 * Get the query params for collections of attachments.
-	 *
-	 * @return array
-	 */
-	public function get_collection_params() {
-
-		return array_merge(
-
-			parent::get_collection_params(),
-
-			array(
-				'status' => array(
-					'default'           => $this->get_post_statuses(),
-					'description'       => __( 'Limit result set to resources assigned one or more statuses.', 'invoicing' ),
-					'type'              => array( 'array', 'string' ),
-					'items'             => array(
-						'enum'          => $this->get_post_statuses(),
-						'type'          => 'string',
-					),
-					'validate_callback' => 'rest_validate_request_arg',
-					'sanitize_callback' => array( $this, 'sanitize_post_statuses' ),
-				),
-				'after' => array(
-					'description'        => __( 'Limit response to resources created after a given ISO8601 compliant date.', 'invoicing' ),
-					'type'               => 'string',
-					'format'             => 'string',
-					'validate_callback'  => 'rest_validate_request_arg',
-					'sanitize_callback'  => 'sanitize_text_field',
-				),
-				'before' => array(
-					'description'        => __( 'Limit response to resources created before a given ISO8601 compliant date.', 'invoicing' ),
-					'type'               => 'string',
-					'format'             => 'string',
-					'validate_callback'  => 'rest_validate_request_arg',
-					'sanitize_callback'  => 'sanitize_text_field',
-				),
-				'exclude' => array(
-					'description'       => __( 'Ensure result set excludes specific IDs.', 'invoicing' ),
-					'type'              => 'array',
-					'items'             => array(
-						'type'          => 'integer',
-					),
-					'default'           => array(),
-					'sanitize_callback' => 'wp_parse_id_list',
-					'validate_callback' => 'rest_validate_request_arg',
-				),
-				'include' => array(
-					'description'       => __( 'Limit result set to specific ids.', 'invoicing' ),
-					'type'              => 'array',
-					'items'             => array(
-						'type'          => 'integer',
-					),
-					'default'           => array(),
-					'sanitize_callback' => 'wp_parse_id_list',
-					'validate_callback' => 'rest_validate_request_arg',
-				),
-				'offset' => array(
-					'description'        => __( 'Offset the result set by a specific number of items.', 'invoicing' ),
-					'type'               => 'integer',
-					'sanitize_callback'  => 'absint',
-					'validate_callback'  => 'rest_validate_request_arg',
-				),
-				'order' => array(
-					'description'        => __( 'Order sort attribute ascending or descending.', 'invoicing' ),
-					'type'               => 'string',
-					'default'            => 'desc',
-					'enum'               => array( 'asc', 'desc' ),
-					'validate_callback'  => 'rest_validate_request_arg',
-				),
-				'orderby' => array(
-					'description'        => __( 'Sort collection by object attribute.', 'invoicing' ),
-					'type'               => 'string',
-					'default'            => 'date',
-					'enum'               => array(
-						'date',
-						'id',
-						'include',
-						'title',
-						'slug',
-						'modified',
-					),
-					'validate_callback'  => 'rest_validate_request_arg',
-				),
-			)
-		);
-	}
-
-	/**
-	 * Retrieves the items's schema, conforming to JSON Schema.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @return array Item schema data.
-	 */
-	public function get_item_schema() {
-
-		// Maybe retrieve the schema from cache.
-		if ( ! empty( $this->schema ) ) {
-			return $this->add_additional_fields_schema( $this->schema );
-		}
-
-		$type   = str_replace( 'wpi_', '', $this->post_type );
-		$schema = array(
-			'$schema'    => 'http://json-schema.org/draft-04/schema#',
-			'title'      => $this->post_type,
-			'type'       => 'object',
-			'properties' => wpinv_get_data( "$type-schema" ),
-		);
-
-		// Filters the invoice schema for the REST API.
+    /**
+     * Update a single object.
+     *
+     * @param WP_REST_Request $request Full details about the request.
+     * @return WP_Error|WP_REST_Response
+     */
+    public function update_item( $request ) {
+
+        // Create item.
+        $response = parent::update_item( $request );
+
+        // Fire a hook after an item is created.
+        if ( ! is_wp_error( $response ) ) {
+
+            /**
+             * Fires after a single item is created or updated via the REST API.
+             *
+             * @param WP_Post         $post      Post object.
+             * @param WP_REST_Request $request   Request object.
+             * @param boolean         $creating  True when creating item, false when updating.
+             */
+            do_action( "getpaid_rest_insert_{$this->post_type}", $this->data_object, $request, false );
+
+        }
+
+        return $response;
+
+    }
+
+    /**
+     * Get a collection of objects.
+     *
+     * @param WP_REST_Request $request Full details about the request.
+     * @return WP_Error|WP_REST_Response
+     */
+    public function get_items( $request ) {
+
+        $args                         = array();
+        $args['offset']               = $request['offset'];
+        $args['order']                = $request['order'];
+        $args['orderby']              = $request['orderby'];
+        $args['paged']                = $request['page'];
+        $args['post__in']             = $request['include'];
+        $args['post__not_in']         = $request['exclude'];
+        $args['posts_per_page']       = $request['per_page'];
+        $args['name']                 = $request['slug'];
+        $args['post_parent__in']      = $request['parent'];
+        $args['post_parent__not_in']  = $request['parent_exclude'];
+        $args['s']                    = $request['search'];
+        $args['post_status']          = wpinv_parse_list( $request['status'] );
+
+        $args['date_query'] = array();
+
+        // Set before into date query. Date query must be specified as an array of an array.
+        if ( isset( $request['before'] ) ) {
+            $args['date_query'][0]['before'] = $request['before'];
+        }
+
+        // Set after into date query. Date query must be specified as an array of an array.
+        if ( isset( $request['after'] ) ) {
+            $args['date_query'][0]['after'] = $request['after'];
+        }
+
+        // Force the post_type & fields arguments, since they're not a user input variable.
+        $args['post_type'] = $this->post_type;
+        $args['fields']    = 'ids';
+
+        // Filter the query arguments for a request.
+        $args       = apply_filters( "getpaid_rest_{$this->post_type}_query", $args, $request );
+        $query_args = $this->prepare_items_query( $args, $request );
+
+        $posts_query = new WP_Query();
+        $query_result = $posts_query->query( $query_args );
+
+        $posts = array();
+        foreach ( $query_result as $post_id ) {
+            if ( ! $this->check_post_permissions( 'read', $post_id ) ) {
+                continue;
+            }
+
+            $data    = $this->prepare_item_for_response( $this->get_object( $post_id ), $request );
+            $posts[] = $this->prepare_response_for_collection( $data );
+        }
+
+        $page        = (int) $query_args['paged'];
+        $total_posts = $posts_query->found_posts;
+
+        if ( $total_posts < 1 ) {
+            // Out-of-bounds, run the query again without LIMIT for total count.
+            unset( $query_args['paged'] );
+            $count_query = new WP_Query();
+            $count_query->query( $query_args );
+            $total_posts = $count_query->found_posts;
+        }
+
+        $max_pages = ceil( $total_posts / (int) $query_args['posts_per_page'] );
+
+        $response = rest_ensure_response( $posts );
+        $response->header( 'X-WP-Total', (int) $total_posts );
+        $response->header( 'X-WP-TotalPages', (int) $max_pages );
+
+        $request_params = $request->get_query_params();
+        $base = add_query_arg( $request_params, rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ) );
+
+        if ( $page > 1 ) {
+            $prev_page = $page - 1;
+            if ( $prev_page > $max_pages ) {
+                $prev_page = $max_pages;
+            }
+            $prev_link = add_query_arg( 'page', $prev_page, $base );
+            $response->link_header( 'prev', $prev_link );
+        }
+        if ( $max_pages > $page ) {
+            $next_page = $page + 1;
+            $next_link = add_query_arg( 'page', $next_page, $base );
+            $response->link_header( 'next', $next_link );
+        }
+
+        return $response;
+    }
+
+    /**
+     * Delete a single item.
+     *
+     * @param WP_REST_Request $request Full details about the request.
+     * @return WP_REST_Response|WP_Error
+     */
+    public function delete_item( $request ) {
+
+        // Fetch the item.
+        $item = $this->get_object( $request['id'] );
+        if ( is_wp_error( $item ) ) {
+            return $item;
+        }
+
+        $supports_trash = EMPTY_TRASH_DAYS > 0;
+        $force          = $supports_trash && (bool) $request['force'];
+
+        if ( ! $this->check_post_permissions( 'delete', $item->ID ) ) {
+            return new WP_Error( "cannot_delete", __( 'Sorry, you are not allowed to delete this resource.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) );
+        }
+
+        $request->set_param( 'context', 'edit' );
+        $response = $this->prepare_item_for_response( $item, $request );
+
+        if ( ! wp_delete_post( $item->ID, $force ) ) {
+            return new WP_Error( 'rest_cannot_delete', sprintf( __( 'The resource cannot be deleted.', 'invoicing' ), $this->post_type ), array( 'status' => 500 ) );
+        }
+
+        return $response;
+    }
+
+    /**
+     * Prepare links for the request.
+     *
+     * @param GetPaid_Data    $object GetPaid_Data object.
+     * @return array Links for the given object.
+     */
+    protected function prepare_links( $object ) {
+
+        $links = parent::prepare_links( $object );
+
+        if ( is_callable( array( $object, 'get_user_id' ) ) ) {
+            $links['user'] = array(
+                'href'       => rest_url( 'wp/v2/users/' . call_user_func(  array( $object, 'get_user_id' )  ) ),
+                'embeddable' => true,
+            );
+        }
+
+        if ( is_callable( array( $object, 'get_owner' ) ) ) {
+            $links['owner']  = array(
+                'href'       => rest_url( 'wp/v2/users/' . call_user_func(  array( $object, 'get_owner' )  ) ),
+                'embeddable' => true,
+            );
+        }
+
+        if ( is_callable( array( $object, 'get_parent_id' ) ) && call_user_func(  array( $object, 'get_parent_id' )  ) ) {
+            $links['parent']  = array(
+                'href'       => rest_url( "$this->namespace/$this->rest_base/" . call_user_func(  array( $object, 'get_parent_id' )  ) ),
+                'embeddable' => true,
+            );
+        }
+
+        return $links;
+    }
+
+    /**
+     * Determine the allowed query_vars for a get_items() response and
+     * prepare for WP_Query.
+     *
+     * @param array           $prepared_args Prepared arguments.
+     * @param WP_REST_Request $request Request object.
+     * @return array          $query_args
+     */
+    protected function prepare_items_query( $prepared_args = array(), $request = null ) {
+
+        $valid_vars = array_flip( $this->get_allowed_query_vars() );
+        $query_args = array();
+        foreach ( $valid_vars as $var => $index ) {
+            if ( isset( $prepared_args[ $var ] ) ) {
+                $query_args[ $var ] = apply_filters( "getpaid_rest_query_var-{$var}", $prepared_args[ $var ], $index );
+            }
+        }
+
+        $query_args['ignore_sticky_posts'] = true;
+
+        if ( 'include' === $query_args['orderby'] ) {
+            $query_args['orderby'] = 'post__in';
+        } elseif ( 'id' === $query_args['orderby'] ) {
+            $query_args['orderby'] = 'ID'; // ID must be capitalized.
+        } elseif ( 'slug' === $query_args['orderby'] ) {
+            $query_args['orderby'] = 'name';
+        }
+
+        return apply_filters( 'getpaid_rest_prepare_items_query', $query_args, $request, $this );
+
+    }
+
+    /**
+     * Get all the WP Query vars that are allowed for the API request.
+     *
+     * @return array
+     */
+    protected function get_allowed_query_vars() {
+        global $wp;
+
+        /**
+         * Filter the publicly allowed query vars.
+         *
+         * Allows adjusting of the default query vars that are made public.
+         *
+         * @param array  Array of allowed WP_Query query vars.
+         */
+        $valid_vars = apply_filters( 'query_vars', $wp->public_query_vars );
+
+        $post_type_obj = get_post_type_object( $this->post_type );
+        if ( current_user_can( $post_type_obj->cap->edit_posts ) ) {
+            $private = apply_filters( 'getpaid_rest_private_query_vars', $wp->private_query_vars );
+            $valid_vars = array_merge( $valid_vars, $private );
+        }
+
+        // Define our own in addition to WP's normal vars.
+        $rest_valid = array(
+            'post_status',
+            'date_query',
+            'ignore_sticky_posts',
+            'offset',
+            'post__in',
+            'post__not_in',
+            'post_parent',
+            'post_parent__in',
+            'post_parent__not_in',
+            'posts_per_page',
+            'meta_query',
+            'tax_query',
+            'meta_key',
+            'meta_value',
+            'meta_compare',
+            'meta_value_num',
+        );
+        $valid_vars = array_merge( $valid_vars, $rest_valid );
+
+        // Filter allowed query vars for the REST API.
+        $valid_vars = apply_filters( 'getpaid_rest_query_vars', $valid_vars, $this );
+
+        return $valid_vars;
+    }
+
+    /**
+     * Get the query params for collections of attachments.
+     *
+     * @return array
+     */
+    public function get_collection_params() {
+
+        return array_merge(
+
+            parent::get_collection_params(),
+
+            array(
+                'status' => array(
+                    'default'           => $this->get_post_statuses(),
+                    'description'       => __( 'Limit result set to resources assigned one or more statuses.', 'invoicing' ),
+                    'type'              => array( 'array', 'string' ),
+                    'items'             => array(
+                        'enum'          => $this->get_post_statuses(),
+                        'type'          => 'string',
+                    ),
+                    'validate_callback' => 'rest_validate_request_arg',
+                    'sanitize_callback' => array( $this, 'sanitize_post_statuses' ),
+                ),
+                'after' => array(
+                    'description'        => __( 'Limit response to resources created after a given ISO8601 compliant date.', 'invoicing' ),
+                    'type'               => 'string',
+                    'format'             => 'string',
+                    'validate_callback'  => 'rest_validate_request_arg',
+                    'sanitize_callback'  => 'sanitize_text_field',
+                ),
+                'before' => array(
+                    'description'        => __( 'Limit response to resources created before a given ISO8601 compliant date.', 'invoicing' ),
+                    'type'               => 'string',
+                    'format'             => 'string',
+                    'validate_callback'  => 'rest_validate_request_arg',
+                    'sanitize_callback'  => 'sanitize_text_field',
+                ),
+                'exclude' => array(
+                    'description'       => __( 'Ensure result set excludes specific IDs.', 'invoicing' ),
+                    'type'              => 'array',
+                    'items'             => array(
+                        'type'          => 'integer',
+                    ),
+                    'default'           => array(),
+                    'sanitize_callback' => 'wp_parse_id_list',
+                    'validate_callback' => 'rest_validate_request_arg',
+                ),
+                'include' => array(
+                    'description'       => __( 'Limit result set to specific ids.', 'invoicing' ),
+                    'type'              => 'array',
+                    'items'             => array(
+                        'type'          => 'integer',
+                    ),
+                    'default'           => array(),
+                    'sanitize_callback' => 'wp_parse_id_list',
+                    'validate_callback' => 'rest_validate_request_arg',
+                ),
+                'offset' => array(
+                    'description'        => __( 'Offset the result set by a specific number of items.', 'invoicing' ),
+                    'type'               => 'integer',
+                    'sanitize_callback'  => 'absint',
+                    'validate_callback'  => 'rest_validate_request_arg',
+                ),
+                'order' => array(
+                    'description'        => __( 'Order sort attribute ascending or descending.', 'invoicing' ),
+                    'type'               => 'string',
+                    'default'            => 'desc',
+                    'enum'               => array( 'asc', 'desc' ),
+                    'validate_callback'  => 'rest_validate_request_arg',
+                ),
+                'orderby' => array(
+                    'description'        => __( 'Sort collection by object attribute.', 'invoicing' ),
+                    'type'               => 'string',
+                    'default'            => 'date',
+                    'enum'               => array(
+                        'date',
+                        'id',
+                        'include',
+                        'title',
+                        'slug',
+                        'modified',
+                    ),
+                    'validate_callback'  => 'rest_validate_request_arg',
+                ),
+            )
+        );
+    }
+
+    /**
+     * Retrieves the items's schema, conforming to JSON Schema.
+     *
+     * @since 1.0.19
+     *
+     * @return array Item schema data.
+     */
+    public function get_item_schema() {
+
+        // Maybe retrieve the schema from cache.
+        if ( ! empty( $this->schema ) ) {
+            return $this->add_additional_fields_schema( $this->schema );
+        }
+
+        $type   = str_replace( 'wpi_', '', $this->post_type );
+        $schema = array(
+            '$schema'    => 'http://json-schema.org/draft-04/schema#',
+            'title'      => $this->post_type,
+            'type'       => 'object',
+            'properties' => wpinv_get_data( "$type-schema" ),
+        );
+
+        // Filters the invoice schema for the REST API.
         $schema = apply_filters( "wpinv_rest_{$type}_schema", $schema );
 
-		// Cache the invoice schema.
-		$this->schema = $schema;
-
-		return $this->add_additional_fields_schema( $this->schema );
-	}
-
-	/**
-	 * Sanitizes and validates the list of post statuses.
-	 *
-	 * @since 1.0.13
-	 *
-	 * @param string|array    $statuses  One or more post statuses.
-	 * @param WP_REST_Request $request   Full details about the request.
-	 * @param string          $parameter Additional parameter to pass to validation.
-	 * @return array|WP_Error A list of valid statuses, otherwise WP_Error object.
-	 */
-	public function sanitize_post_statuses( $statuses, $request, $parameter ) {
-		return array_intersect( wp_parse_slug_list( $statuses ), $this->get_post_statuses() );
-	}
-
-	/**
-	 * Retrieves a valid list of post statuses.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @return array A list of registered item statuses.
-	 */
-	public function get_post_statuses() {
-		return get_post_stati();
-	}
-
-	/**
-	 * Checks if a key should be included in a response.
-	 *
-	 * @since  1.0.19
-	 * @param  GetPaid_Data $object  Data object.
-	 * @param  string       $field_key The key to check for.
-	 * @return bool
-	 */
-	public function object_supports_field( $object, $field_key ) {
-		$supports = parent::object_supports_field( $object, $field_key );
-		return apply_filters( "getpaid_rest_{$this->post_type}_object_supports_key", $supports, $object, $field_key );
-	}
+        // Cache the invoice schema.
+        $this->schema = $schema;
+
+        return $this->add_additional_fields_schema( $this->schema );
+    }
+
+    /**
+     * Sanitizes and validates the list of post statuses.
+     *
+     * @since 1.0.13
+     *
+     * @param string|array    $statuses  One or more post statuses.
+     * @param WP_REST_Request $request   Full details about the request.
+     * @param string          $parameter Additional parameter to pass to validation.
+     * @return array|WP_Error A list of valid statuses, otherwise WP_Error object.
+     */
+    public function sanitize_post_statuses( $statuses, $request, $parameter ) {
+        return array_intersect( wp_parse_slug_list( $statuses ), $this->get_post_statuses() );
+    }
+
+    /**
+     * Retrieves a valid list of post statuses.
+     *
+     * @since 1.0.19
+     *
+     * @return array A list of registered item statuses.
+     */
+    public function get_post_statuses() {
+        return get_post_stati();
+    }
+
+    /**
+     * Checks if a key should be included in a response.
+     *
+     * @since  1.0.19
+     * @param  GetPaid_Data $object  Data object.
+     * @param  string       $field_key The key to check for.
+     * @return bool
+     */
+    public function object_supports_field( $object, $field_key ) {
+        $supports = parent::object_supports_field( $object, $field_key );
+        return apply_filters( "getpaid_rest_{$this->post_type}_object_supports_key", $supports, $object, $field_key );
+    }
 
 }

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

Indentation +181 added lines, -181 removed lines

@@ -11,186 +11,186 @@
  */
 class GetPaid_Data_Store {
 
-	/**
-	 * Contains an instance of the data store class that we are working with.
-	 *
-	 * @var GetPaid_Data_Store
-	 */
-	private $instance = null;
-
-	/**
-	 * Contains an array of default supported data stores.
-	 * Format of object name => class name.
-	 * Example: 'item' => 'GetPaid_Item_Data_Store'
-	 * You can also pass something like item-<type> for item stores and
-	 * that type will be used first when available, if a store is requested like
-	 * this and doesn't exist, then the store would fall back to 'item'.
-	 * Ran through `getpaid_data_stores`.
-	 *
-	 * @var array
-	 */
-	private $stores = array(
-		'item'         => 'GetPaid_Item_Data_Store',
-		'payment_form' => 'GetPaid_Payment_Form_Data_Store',
-		'discount'     => 'GetPaid_Discount_Data_Store',
-		'invoice'      => 'GetPaid_Invoice_Data_Store',
-		'subscription' => 'GetPaid_Subscription_Data_Store',
-	);
-
-	/**
-	 * Contains the name of the current data store's class name.
-	 *
-	 * @var string
-	 */
-	private $current_class_name = '';
-
-	/**
-	 * The object type this store works with.
-	 *
-	 * @var string
-	 */
-	private $object_type = '';
-
-	/**
-	 * Tells GetPaid_Data_Store which object
-	 * store we want to work with.
-	 *
-	 * @param string $object_type Name of object.
-	 */
-	public function __construct( $object_type ) {
-		$this->object_type = $object_type;
-		$this->stores      = apply_filters( 'getpaid_data_stores', $this->stores );
-
-		// If this object type can't be found, check to see if we can load one
-		// level up (so if item-type isn't found, we try item).
-		if ( ! array_key_exists( $object_type, $this->stores ) ) {
-			$pieces      = explode( '-', $object_type );
-			$object_type = $pieces[0];
-		}
-
-		if ( array_key_exists( $object_type, $this->stores ) ) {
-			$store = apply_filters( 'getpaid_' . $object_type . '_data_store', $this->stores[ $object_type ] );
-			if ( is_object( $store ) ) {
-				$this->current_class_name = get_class( $store );
-				$this->instance           = $store;
-			} else {
-				if ( ! class_exists( $store ) ) {
-					throw new Exception( __( 'Data store class does not exist.', 'invoicing' ) );
-				}
-				$this->current_class_name = $store;
-				$this->instance           = new $store();
-			}
-		} else {
-			throw new Exception( __( 'Invalid data store.', 'invoicing' ) );
-		}
-	}
-
-	/**
-	 * Only store the object type to avoid serializing the data store instance.
-	 *
-	 * @return array
-	 */
-	public function __sleep() {
-		return array( 'object_type' );
-	}
-
-	/**
-	 * Re-run the constructor with the object type.
-	 *
-	 * @throws Exception When validation fails.
-	 */
-	public function __wakeup() {
-		$this->__construct( $this->object_type );
-	}
-
-	/**
-	 * Loads a data store.
-	 *
-	 * @param string $object_type Name of object.
-	 *
-	 * @since 1.0.19
-	 * @throws Exception When validation fails.
-	 * @return GetPaid_Data_Store
-	 */
-	public static function load( $object_type ) {
-		return new GetPaid_Data_Store( $object_type );
-	}
-
-	/**
-	 * Returns the class name of the current data store.
-	 *
-	 * @since 1.0.19
-	 * @return string
-	 */
-	public function get_current_class_name() {
-		return $this->current_class_name;
-	}
-
-	/**
-	 * Returns the object type of the current data store.
-	 *
-	 * @since 1.0.19
-	 * @return string
-	 */
-	public function get_object_type() {
-		return $this->object_type;
-	}
-
-	/**
-	 * Reads an object from the data store.
-	 *
-	 * @since 1.0.19
-	 * @param GetPaid_Data $data GetPaid data instance.
-	 */
-	public function read( &$data ) {
-		$this->instance->read( $data );
-	}
-
-	/**
-	 * Create an object in the data store.
-	 *
-	 * @since 1.0.19
-	 * @param GetPaid_Data $data GetPaid data instance.
-	 */
-	public function create( &$data ) {
-		$this->instance->create( $data );
-	}
-
-	/**
-	 * Update an object in the data store.
-	 *
-	 * @since 1.0.19
-	 * @param GetPaid_Data $data GetPaid data instance.
-	 */
-	public function update( &$data ) {
-		$this->instance->update( $data );
-	}
-
-	/**
-	 * Delete an object from the data store.
-	 *
-	 * @since 1.0.19
-	 * @param GetPaid_Data $data GetPaid data instance.
-	 * @param array   $args Array of args to pass to the delete method.
-	 */
-	public function delete( &$data, $args = array() ) {
-		$this->instance->delete( $data, $args );
-	}
-
-	/**
-	 * Data stores can define additional function. This passes
-	 * through to the instance if that function exists.
-	 *
-	 * @since 1.0.19
-	 * @param string $method     Method.
-	 * @return mixed
-	 */
-	public function __call( $method, $parameters ) {
-		if ( is_callable( array( $this->instance, $method ) ) ) {
-			$object     = array_shift( $parameters );
-			$parameters = array_merge( array( &$object ), $parameters );
-			return call_user_func_array( array( $this->instance, $method ), $parameters );
-		}
-	}
+    /**
+     * Contains an instance of the data store class that we are working with.
+     *
+     * @var GetPaid_Data_Store
+     */
+    private $instance = null;
+
+    /**
+     * Contains an array of default supported data stores.
+     * Format of object name => class name.
+     * Example: 'item' => 'GetPaid_Item_Data_Store'
+     * You can also pass something like item-<type> for item stores and
+     * that type will be used first when available, if a store is requested like
+     * this and doesn't exist, then the store would fall back to 'item'.
+     * Ran through `getpaid_data_stores`.
+     *
+     * @var array
+     */
+    private $stores = array(
+        'item'         => 'GetPaid_Item_Data_Store',
+        'payment_form' => 'GetPaid_Payment_Form_Data_Store',
+        'discount'     => 'GetPaid_Discount_Data_Store',
+        'invoice'      => 'GetPaid_Invoice_Data_Store',
+        'subscription' => 'GetPaid_Subscription_Data_Store',
+    );
+
+    /**
+     * Contains the name of the current data store's class name.
+     *
+     * @var string
+     */
+    private $current_class_name = '';
+
+    /**
+     * The object type this store works with.
+     *
+     * @var string
+     */
+    private $object_type = '';
+
+    /**
+     * Tells GetPaid_Data_Store which object
+     * store we want to work with.
+     *
+     * @param string $object_type Name of object.
+     */
+    public function __construct( $object_type ) {
+        $this->object_type = $object_type;
+        $this->stores      = apply_filters( 'getpaid_data_stores', $this->stores );
+
+        // If this object type can't be found, check to see if we can load one
+        // level up (so if item-type isn't found, we try item).
+        if ( ! array_key_exists( $object_type, $this->stores ) ) {
+            $pieces      = explode( '-', $object_type );
+            $object_type = $pieces[0];
+        }
+
+        if ( array_key_exists( $object_type, $this->stores ) ) {
+            $store = apply_filters( 'getpaid_' . $object_type . '_data_store', $this->stores[ $object_type ] );
+            if ( is_object( $store ) ) {
+                $this->current_class_name = get_class( $store );
+                $this->instance           = $store;
+            } else {
+                if ( ! class_exists( $store ) ) {
+                    throw new Exception( __( 'Data store class does not exist.', 'invoicing' ) );
+                }
+                $this->current_class_name = $store;
+                $this->instance           = new $store();
+            }
+        } else {
+            throw new Exception( __( 'Invalid data store.', 'invoicing' ) );
+        }
+    }
+
+    /**
+     * Only store the object type to avoid serializing the data store instance.
+     *
+     * @return array
+     */
+    public function __sleep() {
+        return array( 'object_type' );
+    }
+
+    /**
+     * Re-run the constructor with the object type.
+     *
+     * @throws Exception When validation fails.
+     */
+    public function __wakeup() {
+        $this->__construct( $this->object_type );
+    }
+
+    /**
+     * Loads a data store.
+     *
+     * @param string $object_type Name of object.
+     *
+     * @since 1.0.19
+     * @throws Exception When validation fails.
+     * @return GetPaid_Data_Store
+     */
+    public static function load( $object_type ) {
+        return new GetPaid_Data_Store( $object_type );
+    }
+
+    /**
+     * Returns the class name of the current data store.
+     *
+     * @since 1.0.19
+     * @return string
+     */
+    public function get_current_class_name() {
+        return $this->current_class_name;
+    }
+
+    /**
+     * Returns the object type of the current data store.
+     *
+     * @since 1.0.19
+     * @return string
+     */
+    public function get_object_type() {
+        return $this->object_type;
+    }
+
+    /**
+     * Reads an object from the data store.
+     *
+     * @since 1.0.19
+     * @param GetPaid_Data $data GetPaid data instance.
+     */
+    public function read( &$data ) {
+        $this->instance->read( $data );
+    }
+
+    /**
+     * Create an object in the data store.
+     *
+     * @since 1.0.19
+     * @param GetPaid_Data $data GetPaid data instance.
+     */
+    public function create( &$data ) {
+        $this->instance->create( $data );
+    }
+
+    /**
+     * Update an object in the data store.
+     *
+     * @since 1.0.19
+     * @param GetPaid_Data $data GetPaid data instance.
+     */
+    public function update( &$data ) {
+        $this->instance->update( $data );
+    }
+
+    /**
+     * Delete an object from the data store.
+     *
+     * @since 1.0.19
+     * @param GetPaid_Data $data GetPaid data instance.
+     * @param array   $args Array of args to pass to the delete method.
+     */
+    public function delete( &$data, $args = array() ) {
+        $this->instance->delete( $data, $args );
+    }
+
+    /**
+     * Data stores can define additional function. This passes
+     * through to the instance if that function exists.
+     *
+     * @since 1.0.19
+     * @param string $method     Method.
+     * @return mixed
+     */
+    public function __call( $method, $parameters ) {
+        if ( is_callable( array( $this->instance, $method ) ) ) {
+            $object     = array_shift( $parameters );
+            $parameters = array_merge( array( &$object ), $parameters );
+            return call_user_func_array( array( $this->instance, $method ), $parameters );
+        }
+    }
 
 }

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

Indentation +568 added lines, -568 removed lines

@@ -13,449 +13,449 @@ 
  */
 abstract class GetPaid_Payment_Gateway {
 
-	/**
-	 * Set if the place checkout button should be renamed on selection.
-	 *
-	 * @var string
-	 */
-	public $checkout_button_text;
-
-	/**
-	 * Boolean whether the method is enabled.
-	 *
-	 * @var bool
-	 */
-	public $enabled = true;
-
-	/**
-	 * Payment method id.
-	 *
-	 * @var string
-	 */
-	public $id;
-
-	/**
-	 * Payment method order.
-	 *
-	 * @var int
-	 */
-	public $order = 10;
-
-	/**
-	 * Payment method title for the frontend.
-	 *
-	 * @var string
-	 */
-	public $title;
-
-	/**
-	 * Payment method description for the frontend.
-	 *
-	 * @var string
-	 */
-	public $description;
-
-	/**
-	 * Gateway title.
-	 *
-	 * @var string
-	 */
-	public $method_title = '';
-
-	/**
-	 * Gateway description.
-	 *
-	 * @var string
-	 */
-	public $method_description = '';
-
-	/**
-	 * Countries this gateway is allowed for.
-	 *
-	 * @var array
-	 */
-	public $countries;
-
-	/**
-	 * Currencies this gateway is allowed for.
-	 *
-	 * @var array
-	 */
-	public $currencies;
-
-	/**
-	 * Currencies this gateway is not allowed for.
-	 *
-	 * @var array
-	 */
-	public $exclude_currencies;
-
-	/**
-	 * Maximum transaction amount, zero does not define a maximum.
-	 *
-	 * @var int
-	 */
-	public $max_amount = 0;
-
-	/**
-	 * Optional URL to view a transaction.
-	 *
-	 * @var string
-	 */
-	public $view_transaction_url = '';
-
-	/**
-	 * Optional URL to view a subscription.
-	 *
-	 * @var string
-	 */
-	public $view_subscription_url = '';
-
-	/**
-	 * Optional label to show for "new payment method" in the payment
-	 * method/token selection radio selection.
-	 *
-	 * @var string
-	 */
-	public $new_method_label = '';
-
-	/**
-	 * Contains a user's saved tokens for this gateway.
-	 *
-	 * @var array
-	 */
-	protected $tokens = array();
-
-	/**
-	 * An array of features that this gateway supports.
-	 *
-	 * @var array
-	 */
-	protected $supports = array();
-
-	/**
-	 * Class constructor.
-	 */
-	public function __construct() {
-		$this->enabled = wpinv_is_gateway_active( $this->id );
-
-		// Register gateway.
-		add_filter( 'wpinv_payment_gateways', array( $this, 'register_gateway' ) );
-
-		// Enable Subscriptions.
-		if ( $this->supports( 'subscription' ) ) {
-			add_filter( "wpinv_{$this->id}_support_subscription", '__return_true' );
-		}
-
-		// Enable sandbox.
-		if ( $this->supports( 'sandbox' ) ) {
-			add_filter( "wpinv_{$this->id}_supports_sandbox", '__return_true' );
-		}
-
-		// Gateway settings.
-		add_filter( "wpinv_gateway_settings_{$this->id}", array( $this, 'admin_settings' ) );
+    /**
+     * Set if the place checkout button should be renamed on selection.
+     *
+     * @var string
+     */
+    public $checkout_button_text;
+
+    /**
+     * Boolean whether the method is enabled.
+     *
+     * @var bool
+     */
+    public $enabled = true;
+
+    /**
+     * Payment method id.
+     *
+     * @var string
+     */
+    public $id;
+
+    /**
+     * Payment method order.
+     *
+     * @var int
+     */
+    public $order = 10;
+
+    /**
+     * Payment method title for the frontend.
+     *
+     * @var string
+     */
+    public $title;
+
+    /**
+     * Payment method description for the frontend.
+     *
+     * @var string
+     */
+    public $description;
+
+    /**
+     * Gateway title.
+     *
+     * @var string
+     */
+    public $method_title = '';
+
+    /**
+     * Gateway description.
+     *
+     * @var string
+     */
+    public $method_description = '';
+
+    /**
+     * Countries this gateway is allowed for.
+     *
+     * @var array
+     */
+    public $countries;
+
+    /**
+     * Currencies this gateway is allowed for.
+     *
+     * @var array
+     */
+    public $currencies;
+
+    /**
+     * Currencies this gateway is not allowed for.
+     *
+     * @var array
+     */
+    public $exclude_currencies;
+
+    /**
+     * Maximum transaction amount, zero does not define a maximum.
+     *
+     * @var int
+     */
+    public $max_amount = 0;
+
+    /**
+     * Optional URL to view a transaction.
+     *
+     * @var string
+     */
+    public $view_transaction_url = '';
+
+    /**
+     * Optional URL to view a subscription.
+     *
+     * @var string
+     */
+    public $view_subscription_url = '';
+
+    /**
+     * Optional label to show for "new payment method" in the payment
+     * method/token selection radio selection.
+     *
+     * @var string
+     */
+    public $new_method_label = '';
+
+    /**
+     * Contains a user's saved tokens for this gateway.
+     *
+     * @var array
+     */
+    protected $tokens = array();
+
+    /**
+     * An array of features that this gateway supports.
+     *
+     * @var array
+     */
+    protected $supports = array();
+
+    /**
+     * Class constructor.
+     */
+    public function __construct() {
+        $this->enabled = wpinv_is_gateway_active( $this->id );
+
+        // Register gateway.
+        add_filter( 'wpinv_payment_gateways', array( $this, 'register_gateway' ) );
+
+        // Enable Subscriptions.
+        if ( $this->supports( 'subscription' ) ) {
+            add_filter( "wpinv_{$this->id}_support_subscription", '__return_true' );
+        }
+
+        // Enable sandbox.
+        if ( $this->supports( 'sandbox' ) ) {
+            add_filter( "wpinv_{$this->id}_supports_sandbox", '__return_true' );
+        }
+
+        // Gateway settings.
+        add_filter( "wpinv_gateway_settings_{$this->id}", array( $this, 'admin_settings' ) );
 		
 
-		// Gateway checkout fiellds.
-		add_action( "wpinv_{$this->id}_cc_form", array( $this, 'payment_fields' ), 10, 2 );
-
-		// Process payment.
-		add_action( "getpaid_gateway_{$this->id}", array( $this, 'process_payment' ), 10, 3 );
+        // Gateway checkout fiellds.
+        add_action( "wpinv_{$this->id}_cc_form", array( $this, 'payment_fields' ), 10, 2 );
+
+        // Process payment.
+        add_action( "getpaid_gateway_{$this->id}", array( $this, 'process_payment' ), 10, 3 );
+
+        // Change the checkout button text.
+        if ( ! empty( $this->checkout_button_text ) ) {
+            add_filter( "getpaid_gateway_{$this->id}_checkout_button_label", array( $this, 'rename_checkout_button' ) );
+        }
+
+        // Check if a gateway is valid for a given currency.
+        add_filter( "getpaid_gateway_{$this->id}_is_valid_for_currency", array( $this, 'validate_currency' ), 10, 2 );
+
+        // Generate the transaction url.
+        add_filter( "getpaid_gateway_{$this->id}_transaction_url", array( $this, 'filter_transaction_url' ), 10, 2 );
+
+        // Generate the subscription url.
+        add_filter( "getpaid_gateway_{$this->id}_subscription_url", array( $this, 'filter_subscription_url' ), 10, 2 );
+
+        // Confirm payments.
+        add_filter( "wpinv_payment_confirm_{$this->id}", array( $this, 'confirm_payment' ), 10, 2 );
+
+        // Verify IPNs.
+        add_action( "wpinv_verify_{$this->id}_ipn", array( $this, 'verify_ipn' ) );
+
+    }
+
+    /**
+     * Checks if this gateway is a given gateway.
+     *
+     * @since 1.0.19
+     * @return bool
+     */
+    public function is( $gateway ) {
+        return $gateway == $this->id;
+    }
+
+    /**
+     * Returns a users saved tokens for this gateway.
+     *
+     * @since 1.0.19
+     * @return array
+     */
+    public function get_tokens( $sandbox = null ) {
+
+        if ( is_user_logged_in() && $this->supports( 'tokens' ) && 0 == count( $this->tokens ) ) {
+            $tokens = get_user_meta( get_current_user_id(), "getpaid_{$this->id}_tokens", true );
+
+            if ( is_array( $tokens ) ) {
+                $this->tokens = $tokens;
+            }
+
+        }
+
+        if ( ! is_bool( $sandbox ) ) {
+            return $this->tokens;
+        }
+
+        $args = array( 'type' => $sandbox ? 'sandbox' : 'live' );
+        return wp_list_filter( $this->tokens, $args );
+
+    }
+
+    /**
+     * Saves a token for this gateway.
+     *
+     * @since 1.0.19
+     */
+    public function save_token( $token ) {
 
-		// Change the checkout button text.
-		if ( ! empty( $this->checkout_button_text ) ) {
-			add_filter( "getpaid_gateway_{$this->id}_checkout_button_label", array( $this, 'rename_checkout_button' ) );
-		}
-
-		// Check if a gateway is valid for a given currency.
-		add_filter( "getpaid_gateway_{$this->id}_is_valid_for_currency", array( $this, 'validate_currency' ), 10, 2 );
-
-		// Generate the transaction url.
-		add_filter( "getpaid_gateway_{$this->id}_transaction_url", array( $this, 'filter_transaction_url' ), 10, 2 );
-
-		// Generate the subscription url.
-		add_filter( "getpaid_gateway_{$this->id}_subscription_url", array( $this, 'filter_subscription_url' ), 10, 2 );
-
-		// Confirm payments.
-		add_filter( "wpinv_payment_confirm_{$this->id}", array( $this, 'confirm_payment' ), 10, 2 );
-
-		// Verify IPNs.
-		add_action( "wpinv_verify_{$this->id}_ipn", array( $this, 'verify_ipn' ) );
-
-	}
-
-	/**
-	 * Checks if this gateway is a given gateway.
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
-	public function is( $gateway ) {
-		return $gateway == $this->id;
-	}
-
-	/**
-	 * Returns a users saved tokens for this gateway.
-	 *
-	 * @since 1.0.19
-	 * @return array
-	 */
-	public function get_tokens( $sandbox = null ) {
-
-		if ( is_user_logged_in() && $this->supports( 'tokens' ) && 0 == count( $this->tokens ) ) {
-			$tokens = get_user_meta( get_current_user_id(), "getpaid_{$this->id}_tokens", true );
-
-			if ( is_array( $tokens ) ) {
-				$this->tokens = $tokens;
-			}
-
-		}
-
-		if ( ! is_bool( $sandbox ) ) {
-			return $this->tokens;
-		}
-
-		$args = array( 'type' => $sandbox ? 'sandbox' : 'live' );
-		return wp_list_filter( $this->tokens, $args );
-
-	}
-
-	/**
-	 * Saves a token for this gateway.
-	 *
-	 * @since 1.0.19
-	 */
-	public function save_token( $token ) {
-
-		$tokens   = $this->get_tokens();
-		$tokens[] = $token;
-
-		update_user_meta( get_current_user_id(), "getpaid_{$this->id}_tokens", $tokens );
-
-		$this->tokens = $tokens;
-
-	}
-
-	/**
-	 * Return the title for admin screens.
-	 *
-	 * @return string
-	 */
-	public function get_method_title() {
-		return apply_filters( 'getpaid_gateway_method_title', $this->method_title, $this );
-	}
-
-	/**
-	 * Return the description for admin screens.
-	 *
-	 * @return string
-	 */
-	public function get_method_description() {
-		return apply_filters( 'getpaid_gateway_method_description', $this->method_description, $this );
-	}
-
-	/**
-	 * Get the success url.
-	 *
-	 * @param WPInv_Invoice $invoice Invoice object.
-	 * @return string
-	 */
-	public function get_return_url( $invoice ) {
-
-		// Payment success url
-		$return_url = add_query_arg(
-			array(
-				'payment-confirm' => $this->id,
-				'invoice_key'     => $invoice->get_key(),
-				'utm_nooverride'  => 1
-			),
-			wpinv_get_success_page_uri()
-		);
-
-		return apply_filters( 'getpaid_gateway_success_url', $return_url, $invoice, $this );
-	}
-
-	/**
-	 * Confirms payments when rendering the success page.
-	 *
-	 * @param string $content Success page content.
-	 * @return string
-	 */
-	public function get_confirm_payment( $content ) {
+        $tokens   = $this->get_tokens();
+        $tokens[] = $token;
+
+        update_user_meta( get_current_user_id(), "getpaid_{$this->id}_tokens", $tokens );
+
+        $this->tokens = $tokens;
+
+    }
+
+    /**
+     * Return the title for admin screens.
+     *
+     * @return string
+     */
+    public function get_method_title() {
+        return apply_filters( 'getpaid_gateway_method_title', $this->method_title, $this );
+    }
+
+    /**
+     * Return the description for admin screens.
+     *
+     * @return string
+     */
+    public function get_method_description() {
+        return apply_filters( 'getpaid_gateway_method_description', $this->method_description, $this );
+    }
+
+    /**
+     * Get the success url.
+     *
+     * @param WPInv_Invoice $invoice Invoice object.
+     * @return string
+     */
+    public function get_return_url( $invoice ) {
+
+        // Payment success url
+        $return_url = add_query_arg(
+            array(
+                'payment-confirm' => $this->id,
+                'invoice_key'     => $invoice->get_key(),
+                'utm_nooverride'  => 1
+            ),
+            wpinv_get_success_page_uri()
+        );
+
+        return apply_filters( 'getpaid_gateway_success_url', $return_url, $invoice, $this );
+    }
+
+    /**
+     * Confirms payments when rendering the success page.
+     *
+     * @param string $content Success page content.
+     * @return string
+     */
+    public function get_confirm_payment( $content ) {
 		
-		// Retrieve the invoice.
-		$invoice_id = getpaid_get_current_invoice_id();
-		$invoice    = wpinv_get_invoice( $invoice_id );
+        // Retrieve the invoice.
+        $invoice_id = getpaid_get_current_invoice_id();
+        $invoice    = wpinv_get_invoice( $invoice_id );
 	
-		// Ensure that it exists and that it is pending payment.
-		if ( empty( $invoice_id ) || ! $invoice->needs_payment() ) {
-			return $content;
-		}
+        // Ensure that it exists and that it is pending payment.
+        if ( empty( $invoice_id ) || ! $invoice->needs_payment() ) {
+            return $content;
+        }
 	
-		// Can the user view this invoice??
-		if ( ! wpinv_user_can_view_invoice( $invoice ) ) {
-			return $content;
-		}
+        // Can the user view this invoice??
+        if ( ! wpinv_user_can_view_invoice( $invoice ) ) {
+            return $content;
+        }
 	
-		// Show payment processing indicator.
-		return wpinv_get_template_html( 'wpinv-payment-processing.php', compact( 'invoice' ) );
-	}
-
-	/**
-	 * Processes ipns and marks payments as complete.
-	 *
-	 * @return void
-	 */
-	public function verify_ipn() {}
-
-	/**
-	 * Get a link to the transaction on the 3rd party gateway site (if applicable).
-	 *
-	 * @param string $transaction_url transaction url.
-	 * @param WPInv_Invoice $invoice Invoice object.
-	 * @return string transaction URL, or empty string.
-	 */
-	public function filter_transaction_url( $transaction_url, $invoice ) {
-
-		$transaction_id  = $invoice->get_transaction_id();
-
-		if ( ! empty( $this->view_transaction_url ) && ! empty( $transaction_id ) ) {
-			$transaction_url = sprintf( $this->view_transaction_url, $transaction_id );
-			$replace         = $this->is_sandbox( $invoice ) ? 'sandbox' : '';
-			$transaction_url = str_replace( '{sandbox}', $replace, $transaction_url );
-		}
-
-		return $transaction_url;
-	}
-
-	/**
-	 * Get a link to the subscription on the 3rd party gateway site (if applicable).
-	 *
-	 * @param string $subscription_url transaction url.
-	 * @param WPInv_Invoice $invoice Invoice object.
-	 * @return string subscription URL, or empty string.
-	 */
-	public function filter_subscription_url( $subscription_url, $invoice ) {
-
-		$profile_id      = $invoice->get_subscription_id();
-
-		if ( ! empty( $this->view_subscription_url ) && ! empty( $profile_id ) ) {
-
-			$subscription_url = sprintf( $this->view_subscription_url, $profile_id );
-			$replace          = $this->is_sandbox( $invoice ) ? 'sandbox' : '';
-			$subscription_url = str_replace( '{sandbox}', $replace, $subscription_url );
-
-		}
-
-		return $subscription_url;
-	}
-
-	/**
-	 * Check if the gateway is available for use.
-	 *
-	 * @return bool
-	 */
-	public function is_available() {
-		return ! empty( $this->enabled );
-	}
-
-	/**
-	 * Return the gateway's title.
-	 *
-	 * @return string
-	 */
-	public function get_title() {
-		return apply_filters( 'getpaid_gateway_title', $this->title, $this );
-	}
-
-	/**
-	 * Return the gateway's description.
-	 *
-	 * @return string
-	 */
-	public function get_description() {
-		return apply_filters( 'getpaid_gateway_description', $this->description, $this );
-	}
-
-	/**
-	 * Process Payment.
-	 *
-	 *
-	 * @param WPInv_Invoice $invoice Invoice.
-	 * @param array $submission_data Posted checkout fields.
-	 * @param GetPaid_Payment_Form_Submission $submission Checkout submission.
-	 * @return void
-	 */
-	public function process_payment( $invoice, $submission_data, $submission ) {
-		// Process the payment then either redirect to the success page or the gateway.
-		do_action( 'getpaid_process_invoice_payment_' . $this->id, $invoice, $submission_data, $submission );
-	}
-
-	/**
-	 * Process refund.
-	 *
-	 * If the gateway declares 'refunds' support, this will allow it to refund.
-	 * a passed in amount.
-	 *
-	 * @param WPInv_Invoice $invoice Invoice.
-	 * @param  float  $amount Refund amount.
-	 * @param  string $reason Refund reason.
-	 * @return WP_Error|bool True or false based on success, or a WP_Error object.
-	 */
-	public function process_refund( $invoice, $amount = null, $reason = '' ) {
-		return apply_filters( 'getpaid_process_invoice_refund_' . $this->id, false, $invoice, $amount, $reason );
-	}
-
-	/**
-	 * Displays the payment fields, credit cards etc.
-	 * 
-	 * @param int $invoice_id 0 or invoice id.
-	 * @param GetPaid_Payment_Form $form Current payment form.
-	 */
-	public function payment_fields( $invoice_id, $form ) {
-		do_action( 'getpaid_getpaid_gateway_payment_fields_' . $this->id, $invoice_id, $form );
-	}
-
-	/**
-	 * Filters the gateway settings.
-	 * 
-	 * @param array $admin_settings
-	 */
-	public function admin_settings( $admin_settings ) {
-		return $admin_settings;
-	}
-
-	/**
-	 * Retrieves the value of a gateway setting.
-	 * 
-	 * @param string $option
-	 */
-	public function get_option( $option, $default = false ) {
-		return wpinv_get_option( $this->id . '_' . $option, $default );
-	}
-
-	/**
-	 * Check if a gateway supports a given feature.
-	 *
-	 * Gateways should override this to declare support (or lack of support) for a feature.
-	 * For backward compatibility, gateways support 'products' by default, but nothing else.
-	 *
-	 * @param string $feature string The name of a feature to test support for.
-	 * @return bool True if the gateway supports the feature, false otherwise.
-	 * @since 1.0.19
-	 */
-	public function supports( $feature ) {
-		return apply_filters( 'getpaid_payment_gateway_supports', in_array( $feature, $this->supports ), $feature, $this );
-	}
-
-	/**
-	 * Returns the credit card form html.
-	 * 
-	 * @param bool $save whether or not to display the save button.
-	 */
+        // Show payment processing indicator.
+        return wpinv_get_template_html( 'wpinv-payment-processing.php', compact( 'invoice' ) );
+    }
+
+    /**
+     * Processes ipns and marks payments as complete.
+     *
+     * @return void
+     */
+    public function verify_ipn() {}
+
+    /**
+     * Get a link to the transaction on the 3rd party gateway site (if applicable).
+     *
+     * @param string $transaction_url transaction url.
+     * @param WPInv_Invoice $invoice Invoice object.
+     * @return string transaction URL, or empty string.
+     */
+    public function filter_transaction_url( $transaction_url, $invoice ) {
+
+        $transaction_id  = $invoice->get_transaction_id();
+
+        if ( ! empty( $this->view_transaction_url ) && ! empty( $transaction_id ) ) {
+            $transaction_url = sprintf( $this->view_transaction_url, $transaction_id );
+            $replace         = $this->is_sandbox( $invoice ) ? 'sandbox' : '';
+            $transaction_url = str_replace( '{sandbox}', $replace, $transaction_url );
+        }
+
+        return $transaction_url;
+    }
+
+    /**
+     * Get a link to the subscription on the 3rd party gateway site (if applicable).
+     *
+     * @param string $subscription_url transaction url.
+     * @param WPInv_Invoice $invoice Invoice object.
+     * @return string subscription URL, or empty string.
+     */
+    public function filter_subscription_url( $subscription_url, $invoice ) {
+
+        $profile_id      = $invoice->get_subscription_id();
+
+        if ( ! empty( $this->view_subscription_url ) && ! empty( $profile_id ) ) {
+
+            $subscription_url = sprintf( $this->view_subscription_url, $profile_id );
+            $replace          = $this->is_sandbox( $invoice ) ? 'sandbox' : '';
+            $subscription_url = str_replace( '{sandbox}', $replace, $subscription_url );
+
+        }
+
+        return $subscription_url;
+    }
+
+    /**
+     * Check if the gateway is available for use.
+     *
+     * @return bool
+     */
+    public function is_available() {
+        return ! empty( $this->enabled );
+    }
+
+    /**
+     * Return the gateway's title.
+     *
+     * @return string
+     */
+    public function get_title() {
+        return apply_filters( 'getpaid_gateway_title', $this->title, $this );
+    }
+
+    /**
+     * Return the gateway's description.
+     *
+     * @return string
+     */
+    public function get_description() {
+        return apply_filters( 'getpaid_gateway_description', $this->description, $this );
+    }
+
+    /**
+     * Process Payment.
+     *
+     *
+     * @param WPInv_Invoice $invoice Invoice.
+     * @param array $submission_data Posted checkout fields.
+     * @param GetPaid_Payment_Form_Submission $submission Checkout submission.
+     * @return void
+     */
+    public function process_payment( $invoice, $submission_data, $submission ) {
+        // Process the payment then either redirect to the success page or the gateway.
+        do_action( 'getpaid_process_invoice_payment_' . $this->id, $invoice, $submission_data, $submission );
+    }
+
+    /**
+     * Process refund.
+     *
+     * If the gateway declares 'refunds' support, this will allow it to refund.
+     * a passed in amount.
+     *
+     * @param WPInv_Invoice $invoice Invoice.
+     * @param  float  $amount Refund amount.
+     * @param  string $reason Refund reason.
+     * @return WP_Error|bool True or false based on success, or a WP_Error object.
+     */
+    public function process_refund( $invoice, $amount = null, $reason = '' ) {
+        return apply_filters( 'getpaid_process_invoice_refund_' . $this->id, false, $invoice, $amount, $reason );
+    }
+
+    /**
+     * Displays the payment fields, credit cards etc.
+     * 
+     * @param int $invoice_id 0 or invoice id.
+     * @param GetPaid_Payment_Form $form Current payment form.
+     */
+    public function payment_fields( $invoice_id, $form ) {
+        do_action( 'getpaid_getpaid_gateway_payment_fields_' . $this->id, $invoice_id, $form );
+    }
+
+    /**
+     * Filters the gateway settings.
+     * 
+     * @param array $admin_settings
+     */
+    public function admin_settings( $admin_settings ) {
+        return $admin_settings;
+    }
+
+    /**
+     * Retrieves the value of a gateway setting.
+     * 
+     * @param string $option
+     */
+    public function get_option( $option, $default = false ) {
+        return wpinv_get_option( $this->id . '_' . $option, $default );
+    }
+
+    /**
+     * Check if a gateway supports a given feature.
+     *
+     * Gateways should override this to declare support (or lack of support) for a feature.
+     * For backward compatibility, gateways support 'products' by default, but nothing else.
+     *
+     * @param string $feature string The name of a feature to test support for.
+     * @return bool True if the gateway supports the feature, false otherwise.
+     * @since 1.0.19
+     */
+    public function supports( $feature ) {
+        return apply_filters( 'getpaid_payment_gateway_supports', in_array( $feature, $this->supports ), $feature, $this );
+    }
+
+    /**
+     * Returns the credit card form html.
+     * 
+     * @param bool $save whether or not to display the save button.
+     */
     public function get_cc_form( $save = false ) {
 
-		ob_start();
+        ob_start();
 
         $id_prefix = esc_attr( uniqid( $this->id ) );
 
@@ -561,175 +561,175 @@ 
 					
 					<?php
 
-						if ( $save ) {
-							echo $this->save_payment_method_checkbox();
-						}
+                        if ( $save ) {
+                            echo $this->save_payment_method_checkbox();
+                        }
 
-					?>
+                    ?>
                 </div>
 
             </div>
 		<?php
 		
-		return ob_get_clean();
+        return ob_get_clean();
+
+    }
+
+    /**
+     * Displays a new payment method entry form.
+     *
+     * @since 1.0.19
+     */
+    public function new_payment_method_entry( $form ) {
+        echo "<div class='getpaid-new-payment-method-form' style='display:none;'>$form</div>";
+    }
+
+    /**
+     * Grab and display our saved payment methods.
+     *
+     * @since 1.0.19
+     */
+    public function saved_payment_methods() {
+        $html = '<ul class="getpaid-saved-payment-methods m-0 mt-2" data-count="' . esc_attr( count( $this->get_tokens( $this->is_sandbox() ) ) ) . '">';
+
+        foreach ( $this->get_tokens( $this->is_sandbox() ) as $token ) {
+            $html .= $this->get_saved_payment_method_option_html( $token );
+        }
 
+        $html .= $this->get_new_payment_method_option_html();
+        $html .= '</ul>';
+
+        echo apply_filters( 'getpaid_payment_gateway_form_saved_payment_methods_html', $html, $this );
     }
 
-	/**
-	 * Displays a new payment method entry form.
-	 *
-	 * @since 1.0.19
-	 */
-	public function new_payment_method_entry( $form ) {
-		echo "<div class='getpaid-new-payment-method-form' style='display:none;'>$form</div>";
-	}
-
-	/**
-	 * Grab and display our saved payment methods.
-	 *
-	 * @since 1.0.19
-	 */
-	public function saved_payment_methods() {
-		$html = '<ul class="getpaid-saved-payment-methods m-0 mt-2" data-count="' . esc_attr( count( $this->get_tokens( $this->is_sandbox() ) ) ) . '">';
-
-		foreach ( $this->get_tokens( $this->is_sandbox() ) as $token ) {
-			$html .= $this->get_saved_payment_method_option_html( $token );
-		}
-
-		$html .= $this->get_new_payment_method_option_html();
-		$html .= '</ul>';
-
-		echo apply_filters( 'getpaid_payment_gateway_form_saved_payment_methods_html', $html, $this );
-	}
-
-	/**
-	 * Gets saved payment method HTML from a token.
-	 *
-	 * @since 1.0.19
-	 * @param  array $token Payment Token.
-	 * @return string Generated payment method HTML
-	 */
-	public function get_saved_payment_method_option_html( $token ) {
-
-		return sprintf(
-			'<li class="getpaid-payment-method form-group">
+    /**
+     * Gets saved payment method HTML from a token.
+     *
+     * @since 1.0.19
+     * @param  array $token Payment Token.
+     * @return string Generated payment method HTML
+     */
+    public function get_saved_payment_method_option_html( $token ) {
+
+        return sprintf(
+            '<li class="getpaid-payment-method form-group">
 				<label>
 					<input name="getpaid-%1$s-payment-method" type="radio" value="%2$s" style="width:auto;" class="getpaid-saved-payment-method-token-input" %4$s />
 					<span>%3$s</span>
 				</label>
 			</li>',
-			esc_attr( $this->id ),
-			esc_attr( $token['id'] ),
-			esc_html( $token['name'] ),
-			checked( empty( $token['default'] ), false, false )
-		);
+            esc_attr( $this->id ),
+            esc_attr( $token['id'] ),
+            esc_html( $token['name'] ),
+            checked( empty( $token['default'] ), false, false )
+        );
 
-	}
+    }
 
-	/**
-	 * Displays a radio button for entering a new payment method (new CC details) instead of using a saved method.
-	 *
-	 * @since 1.0.19
-	 */
-	public function get_new_payment_method_option_html() {
+    /**
+     * Displays a radio button for entering a new payment method (new CC details) instead of using a saved method.
+     *
+     * @since 1.0.19
+     */
+    public function get_new_payment_method_option_html() {
 
-		$label = apply_filters( 'getpaid_new_payment_method_label', $this->new_method_label ? $this->new_method_label : __( 'Use a new payment method', 'invoicing' ), $this );
+        $label = apply_filters( 'getpaid_new_payment_method_label', $this->new_method_label ? $this->new_method_label : __( 'Use a new payment method', 'invoicing' ), $this );
 
-		return sprintf(
-			'<li class="getpaid-new-payment-method">
+        return sprintf(
+            '<li class="getpaid-new-payment-method">
 				<label>
 					<input name="getpaid-%1$s-payment-method" type="radio" value="new" style="width:auto;" />
 					<span>%2$s</span>
 				</label>
 			</li>',
-			esc_attr( $this->id ),
-			esc_html( $label )
-		);
+            esc_attr( $this->id ),
+            esc_html( $label )
+        );
 
-	}
+    }
 
-	/**
-	 * Outputs a checkbox for saving a new payment method to the database.
-	 *
-	 * @since 1.0.19
-	 */
-	public function save_payment_method_checkbox() {
+    /**
+     * Outputs a checkbox for saving a new payment method to the database.
+     *
+     * @since 1.0.19
+     */
+    public function save_payment_method_checkbox() {
 
-		return sprintf(
-			'<p class="form-group getpaid-save-payment-method">
+        return sprintf(
+            '<p class="form-group getpaid-save-payment-method">
 				<label>
 					<input name="getpaid-%1$s-new-payment-method" type="checkbox" value="true" style="width:auto;" />
 					<span>%2$s</span>
 				</label>
 			</p>',
-			esc_attr( $this->id ),
-			esc_html__( 'Save payment method', 'invoicing' )
-		);
+            esc_attr( $this->id ),
+            esc_html__( 'Save payment method', 'invoicing' )
+        );
 
-	}
+    }
 
-	/**
-	 * Registers the gateway.
-	 *
-	 * @return array
-	 */
-	public function register_gateway( $gateways ) {
+    /**
+     * Registers the gateway.
+     *
+     * @return array
+     */
+    public function register_gateway( $gateways ) {
 
-		$gateways[ $this->id ] = array(
+        $gateways[ $this->id ] = array(
 
-			'admin_label'    => $this->method_title,
+            'admin_label'    => $this->method_title,
             'checkout_label' => $this->title,
-			'ordering'       => $this->order,
-
-		);
-
-		return $gateways;
-
-	}
-
-	/**
-	 * Checks whether or not this is a sandbox request.
-	 *
-	 * @param  WPInv_Invoice|null $invoice Invoice object or null.
-	 * @return bool
-	 */
-	public function is_sandbox( $invoice = null ) {
-
-		if ( ! empty( $invoice ) && ! $invoice->needs_payment() ) {
-			return $invoice->get_mode() == 'test';
-		}
-
-		return wpinv_is_test_mode( $this->id );
-
-	}
-
-	/**
-	 * Renames the checkout button
-	 *
-	 * @return string
-	 */
-	public function rename_checkout_button() {
-		return $this->checkout_button_text;
-	}
-
-	/**
-	 * Validate gateway currency
-	 *
-	 * @return bool
-	 */
-	public function validate_currency( $validation, $currency ) {
-
-		// Required currencies.
-		if ( ! empty( $this->currencies ) && ! in_array( $currency, $this->currencies ) ) {
-			return false;
-		}
-
-		// Excluded currencies.
-		if ( ! empty( $this->exclude_currencies ) && in_array( $currency, $this->exclude_currencies ) ) {
-			return false;
-		}
-
-		return $validation;
-	}
+            'ordering'       => $this->order,
+
+        );
+
+        return $gateways;
+
+    }
+
+    /**
+     * Checks whether or not this is a sandbox request.
+     *
+     * @param  WPInv_Invoice|null $invoice Invoice object or null.
+     * @return bool
+     */
+    public function is_sandbox( $invoice = null ) {
+
+        if ( ! empty( $invoice ) && ! $invoice->needs_payment() ) {
+            return $invoice->get_mode() == 'test';
+        }
+
+        return wpinv_is_test_mode( $this->id );
+
+    }
+
+    /**
+     * Renames the checkout button
+     *
+     * @return string
+     */
+    public function rename_checkout_button() {
+        return $this->checkout_button_text;
+    }
+
+    /**
+     * Validate gateway currency
+     *
+     * @return bool
+     */
+    public function validate_currency( $validation, $currency ) {
+
+        // Required currencies.
+        if ( ! empty( $this->currencies ) && ! in_array( $currency, $this->currencies ) ) {
+            return false;
+        }
+
+        // Excluded currencies.
+        if ( ! empty( $this->exclude_currencies ) && in_array( $currency, $this->exclude_currencies ) ) {
+            return false;
+        }
+
+        return $validation;
+    }
 
 }

includes/class-wpinv-subscriptions.php

Indentation +4 added lines, -4 removed lines

@@ -12,8 +12,8 @@ 
 class WPInv_Subscriptions {
 
     /**
-	 * Class constructor.
-	 */
+     * Class constructor.
+     */
     public function __construct(){
 
         // Fire gateway specific hooks when a subscription changes.
@@ -33,12 +33,12 @@ 
     }
 
     /**
-	 * Processes subscription status changes.
+     * Processes subscription status changes.
      * 
      * @param WPInv_Subscription $subscription
      * @param string $from
      * @param string $to
-	 */
+     */
     public function process_subscription_status_change( $subscription, $from, $to ) {
 
         $gateway = $subscription->get_gateway();

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

Indentation +209 added lines, -209 removed lines

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

includes/data-stores/class-getpaid-payment-form-data-store.php

Indentation +169 added lines, -169 removed lines

@@ -4,7 +4,7 @@ 
  *
  */
 if ( ! defined( 'ABSPATH' ) ) {
-	exit;
+    exit;
 }
 
 /**
@@ -14,179 +14,179 @@ 
  */
 class GetPaid_Payment_Form_Data_Store extends GetPaid_Data_Store_WP {
 
-	/**
-	 * Data stored in meta keys, but not considered "meta" for a form.
-	 *
-	 * @since 1.0.19
-	 * @var array
-	 */
-	protected $internal_meta_keys = array(
-		'wpinv_form_elements',
-		'wpinv_form_items',
-		'wpinv_form_earned',
-		'wpinv_form_refunded',
-		'wpinv_form_cancelled',
-		'wpinv_form_failed'
-	);
-
-	/**
-	 * A map of meta keys to data props.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @var array
-	 */
-	protected $meta_key_to_props = array(
-		'wpinv_form_elements'  => 'elements',
-		'wpinv_form_items'     => 'items',
-		'wpinv_form_earned'    => 'earned',
-		'wpinv_form_refunded'  => 'refunded',
-		'wpinv_form_cancelled' => 'cancelled',
-		'wpinv_form_failed'    => 'failed',
-	);
-
-	/*
+    /**
+     * Data stored in meta keys, but not considered "meta" for a form.
+     *
+     * @since 1.0.19
+     * @var array
+     */
+    protected $internal_meta_keys = array(
+        'wpinv_form_elements',
+        'wpinv_form_items',
+        'wpinv_form_earned',
+        'wpinv_form_refunded',
+        'wpinv_form_cancelled',
+        'wpinv_form_failed'
+    );
+
+    /**
+     * A map of meta keys to data props.
+     *
+     * @since 1.0.19
+     *
+     * @var array
+     */
+    protected $meta_key_to_props = array(
+        'wpinv_form_elements'  => 'elements',
+        'wpinv_form_items'     => 'items',
+        'wpinv_form_earned'    => 'earned',
+        'wpinv_form_refunded'  => 'refunded',
+        'wpinv_form_cancelled' => 'cancelled',
+        'wpinv_form_failed'    => 'failed',
+    );
+
+    /*
 	|--------------------------------------------------------------------------
 	| CRUD Methods
 	|--------------------------------------------------------------------------
 	*/
 
-	/**
-	 * Method to create a new form in the database.
-	 *
-	 * @param GetPaid_Payment_Form $form Form object.
-	 */
-	public function create( &$form ) {
-		$form->set_version( WPINV_VERSION );
-		$form->set_date_created( current_time('mysql') );
-
-		// Create a new post.
-		$id = wp_insert_post(
-			apply_filters(
-				'getpaid_new_payment_form_data',
-				array(
-					'post_date'     => $form->get_date_created( 'edit' ),
-					'post_type'     => 'wpi_payment_form',
-					'post_status'   => $this->get_post_status( $form ),
-					'ping_status'   => 'closed',
-					'post_author'   => $form->get_author( 'edit' ),
-					'post_title'    => $form->get_name( 'edit' ),
-				)
-			),
-			true
-		);
-
-		if ( $id && ! is_wp_error( $id ) ) {
-			$form->set_id( $id );
-			$this->update_post_meta( $form );
-			$form->save_meta_data();
-			$form->apply_changes();
-			$this->clear_caches( $form );
-			do_action( 'getpaid_create_payment_form', $form );
-			return true;
-		}
-
-		if ( is_wp_error( $id ) ) {
-			$form->last_error = $id->get_error_message();
-		}
-
-		return false;
-	}
-
-	/**
-	 * Method to read a form from the database.
-	 *
-	 * @param GetPaid_Payment_Form $form Form object.
-	 *
-	 */
-	public function read( &$form ) {
-
-		$form->set_defaults();
-		$form_object = get_post( $form->get_id() );
-
-		if ( ! $form->get_id() || ! $form_object || $form_object->post_type != 'wpi_payment_form' ) {
-			$form->last_error = __( 'Invalid form.', 'invoicing' );
-			$form->set_id( 0 );
-			return false;
-		}
-
-		$form->set_props(
-			array(
-				'date_created'  => 0 < $form_object->post_date ? $form_object->post_date : null,
-				'date_modified' => 0 < $form_object->post_modified ? $form_object->post_modified : null,
-				'status'        => $form_object->post_status,
-				'name'          => $form_object->post_title,
-				'author'        => $form_object->post_author,
-			)
-		);
-
-		$this->read_object_data( $form, $form_object );
-		$form->read_meta_data();
-		$form->set_object_read( true );
-		do_action( 'getpaid_read_payment_form', $form );
-
-	}
-
-	/**
-	 * Method to update a form in the database.
-	 *
-	 * @param GetPaid_Payment_Form $form Form object.
-	 */
-	public function update( &$form ) {
-		$form->save_meta_data();
-		$form->set_version( WPINV_VERSION );
-
-		if ( null === $form->get_date_created( 'edit' ) ) {
-			$form->set_date_created(  current_time('mysql') );
-		}
-
-		// Grab the current status so we can compare.
-		$previous_status = get_post_status( $form->get_id() );
-
-		$changes = $form->get_changes();
-
-		// Only update the post when the post data changes.
-		if ( array_intersect( array( 'date_created', 'date_modified', 'status', 'name', 'author' ), array_keys( $changes ) ) ) {
-			$post_data = array(
-				'post_date'         => $form->get_date_created( 'edit' ),
-				'post_status'       => $form->get_status( 'edit' ),
-				'post_title'        => $form->get_name( 'edit' ),
-				'post_author'       => $form->get_author( 'edit' ),
-				'post_modified'     => $form->get_date_modified( 'edit' ),
-			);
-
-			/**
-			 * When updating this object, to prevent infinite loops, use $wpdb
-			 * to update data, since wp_update_post spawns more calls to the
-			 * save_post action.
-			 *
-			 * This ensures hooks are fired by either WP itself (admin screen save),
-			 * or an update purely from CRUD.
-			 */
-			if ( doing_action( 'save_post' ) ) {
-				$GLOBALS['wpdb']->update( $GLOBALS['wpdb']->posts, $post_data, array( 'ID' => $form->get_id() ) );
-				clean_post_cache( $form->get_id() );
-			} else {
-				wp_update_post( array_merge( array( 'ID' => $form->get_id() ), $post_data ) );
-			}
-			$form->read_meta_data( true ); // Refresh internal meta data, in case things were hooked into `save_post` or another WP hook.
-		}
-		$this->update_post_meta( $form );
-		$form->apply_changes();
-		$this->clear_caches( $form );
-
-		// Fire a hook depending on the status - this should be considered a creation if it was previously draft status.
-		$new_status = $form->get_status( 'edit' );
-
-		if ( $new_status !== $previous_status && in_array( $previous_status, array( 'new', 'auto-draft', 'draft' ), true ) ) {
-			do_action( 'getpaid_new_payment_form', $form );
-		} else {
-			do_action( 'getpaid_update_payment_form', $form );
-		}
-
-	}
-
-	/*
+    /**
+     * Method to create a new form in the database.
+     *
+     * @param GetPaid_Payment_Form $form Form object.
+     */
+    public function create( &$form ) {
+        $form->set_version( WPINV_VERSION );
+        $form->set_date_created( current_time('mysql') );
+
+        // Create a new post.
+        $id = wp_insert_post(
+            apply_filters(
+                'getpaid_new_payment_form_data',
+                array(
+                    'post_date'     => $form->get_date_created( 'edit' ),
+                    'post_type'     => 'wpi_payment_form',
+                    'post_status'   => $this->get_post_status( $form ),
+                    'ping_status'   => 'closed',
+                    'post_author'   => $form->get_author( 'edit' ),
+                    'post_title'    => $form->get_name( 'edit' ),
+                )
+            ),
+            true
+        );
+
+        if ( $id && ! is_wp_error( $id ) ) {
+            $form->set_id( $id );
+            $this->update_post_meta( $form );
+            $form->save_meta_data();
+            $form->apply_changes();
+            $this->clear_caches( $form );
+            do_action( 'getpaid_create_payment_form', $form );
+            return true;
+        }
+
+        if ( is_wp_error( $id ) ) {
+            $form->last_error = $id->get_error_message();
+        }
+
+        return false;
+    }
+
+    /**
+     * Method to read a form from the database.
+     *
+     * @param GetPaid_Payment_Form $form Form object.
+     *
+     */
+    public function read( &$form ) {
+
+        $form->set_defaults();
+        $form_object = get_post( $form->get_id() );
+
+        if ( ! $form->get_id() || ! $form_object || $form_object->post_type != 'wpi_payment_form' ) {
+            $form->last_error = __( 'Invalid form.', 'invoicing' );
+            $form->set_id( 0 );
+            return false;
+        }
+
+        $form->set_props(
+            array(
+                'date_created'  => 0 < $form_object->post_date ? $form_object->post_date : null,
+                'date_modified' => 0 < $form_object->post_modified ? $form_object->post_modified : null,
+                'status'        => $form_object->post_status,
+                'name'          => $form_object->post_title,
+                'author'        => $form_object->post_author,
+            )
+        );
+
+        $this->read_object_data( $form, $form_object );
+        $form->read_meta_data();
+        $form->set_object_read( true );
+        do_action( 'getpaid_read_payment_form', $form );
+
+    }
+
+    /**
+     * Method to update a form in the database.
+     *
+     * @param GetPaid_Payment_Form $form Form object.
+     */
+    public function update( &$form ) {
+        $form->save_meta_data();
+        $form->set_version( WPINV_VERSION );
+
+        if ( null === $form->get_date_created( 'edit' ) ) {
+            $form->set_date_created(  current_time('mysql') );
+        }
+
+        // Grab the current status so we can compare.
+        $previous_status = get_post_status( $form->get_id() );
+
+        $changes = $form->get_changes();
+
+        // Only update the post when the post data changes.
+        if ( array_intersect( array( 'date_created', 'date_modified', 'status', 'name', 'author' ), array_keys( $changes ) ) ) {
+            $post_data = array(
+                'post_date'         => $form->get_date_created( 'edit' ),
+                'post_status'       => $form->get_status( 'edit' ),
+                'post_title'        => $form->get_name( 'edit' ),
+                'post_author'       => $form->get_author( 'edit' ),
+                'post_modified'     => $form->get_date_modified( 'edit' ),
+            );
+
+            /**
+             * When updating this object, to prevent infinite loops, use $wpdb
+             * to update data, since wp_update_post spawns more calls to the
+             * save_post action.
+             *
+             * This ensures hooks are fired by either WP itself (admin screen save),
+             * or an update purely from CRUD.
+             */
+            if ( doing_action( 'save_post' ) ) {
+                $GLOBALS['wpdb']->update( $GLOBALS['wpdb']->posts, $post_data, array( 'ID' => $form->get_id() ) );
+                clean_post_cache( $form->get_id() );
+            } else {
+                wp_update_post( array_merge( array( 'ID' => $form->get_id() ), $post_data ) );
+            }
+            $form->read_meta_data( true ); // Refresh internal meta data, in case things were hooked into `save_post` or another WP hook.
+        }
+        $this->update_post_meta( $form );
+        $form->apply_changes();
+        $this->clear_caches( $form );
+
+        // Fire a hook depending on the status - this should be considered a creation if it was previously draft status.
+        $new_status = $form->get_status( 'edit' );
+
+        if ( $new_status !== $previous_status && in_array( $previous_status, array( 'new', 'auto-draft', 'draft' ), true ) ) {
+            do_action( 'getpaid_new_payment_form', $form );
+        } else {
+            do_action( 'getpaid_update_payment_form', $form );
+        }
+
+    }
+
+    /*
 	|--------------------------------------------------------------------------
 	| Additional Methods
 	|--------------------------------------------------------------------------

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

Indentation +186 added lines, -186 removed lines

@@ -5,7 +5,7 @@ 
  *
  */
 if ( ! defined( 'ABSPATH' ) ) {
-	exit;
+    exit;
 }
 
 /**
@@ -15,196 +15,196 @@ 
  */
 class GetPaid_Discount_Data_Store extends GetPaid_Data_Store_WP {
 
-	/**
-	 * Data stored in meta keys, but not considered "meta" for a discount.
-	 *
-	 * @since 1.0.19
-	 * @var array
-	 */
-	protected $internal_meta_keys = array(
-		'_wpi_discount_code',
-		'_wpi_discount_amount',
-		'_wpi_discount_start',
-		'_wpi_discount_expiration',
-		'_wpi_discount_type',
-		'_wpi_discount_uses',
-		'_wpi_discount_is_single_use',
-		'_wpi_discount_items',
-		'_wpi_discount_excluded_items',
-		'_wpi_discount_max_uses',
-		'_wpi_discount_is_recurring',
-		'_wpi_discount_min_total',
-		'_wpi_discount_max_total',
-	);
-
-	/**
-	 * A map of meta keys to data props.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @var array
-	 */
-	protected $meta_key_to_props = array(
-		'_wpi_discount_code'           => 'code',
-		'_wpi_discount_amount'         => 'amount',
-		'_wpi_discount_start'          => 'start',
-		'_wpi_discount_expiration'     => 'expiration',
-		'_wpi_discount_type'           => 'type',
-		'_wpi_discount_uses'           => 'uses',
-		'_wpi_discount_is_single_use'  => 'is_single_use',
-		'_wpi_discount_items'          => 'items',
-		'_wpi_discount_excluded_items' => 'excluded_items',
-		'_wpi_discount_max_uses'       => 'max_uses',
-		'_wpi_discount_is_recurring'   => 'is_recurring',
-		'_wpi_discount_min_total'      => 'min_total',
-		'_wpi_discount_max_total'      => 'max_total',
-	);
-
-	/*
+    /**
+     * Data stored in meta keys, but not considered "meta" for a discount.
+     *
+     * @since 1.0.19
+     * @var array
+     */
+    protected $internal_meta_keys = array(
+        '_wpi_discount_code',
+        '_wpi_discount_amount',
+        '_wpi_discount_start',
+        '_wpi_discount_expiration',
+        '_wpi_discount_type',
+        '_wpi_discount_uses',
+        '_wpi_discount_is_single_use',
+        '_wpi_discount_items',
+        '_wpi_discount_excluded_items',
+        '_wpi_discount_max_uses',
+        '_wpi_discount_is_recurring',
+        '_wpi_discount_min_total',
+        '_wpi_discount_max_total',
+    );
+
+    /**
+     * A map of meta keys to data props.
+     *
+     * @since 1.0.19
+     *
+     * @var array
+     */
+    protected $meta_key_to_props = array(
+        '_wpi_discount_code'           => 'code',
+        '_wpi_discount_amount'         => 'amount',
+        '_wpi_discount_start'          => 'start',
+        '_wpi_discount_expiration'     => 'expiration',
+        '_wpi_discount_type'           => 'type',
+        '_wpi_discount_uses'           => 'uses',
+        '_wpi_discount_is_single_use'  => 'is_single_use',
+        '_wpi_discount_items'          => 'items',
+        '_wpi_discount_excluded_items' => 'excluded_items',
+        '_wpi_discount_max_uses'       => 'max_uses',
+        '_wpi_discount_is_recurring'   => 'is_recurring',
+        '_wpi_discount_min_total'      => 'min_total',
+        '_wpi_discount_max_total'      => 'max_total',
+    );
+
+    /*
 	|--------------------------------------------------------------------------
 	| CRUD Methods
 	|--------------------------------------------------------------------------
 	*/
 
-	/**
-	 * Method to create a new discount in the database.
-	 *
-	 * @param WPInv_Discount $discount Discount object.
-	 */
-	public function create( &$discount ) {
-		$discount->set_version( WPINV_VERSION );
-		$discount->set_date_created( current_time('mysql') );
-
-		// Create a new post.
-		$id = wp_insert_post(
-			apply_filters(
-				'getpaid_new_discount_data',
-				array(
-					'post_date'     => $discount->get_date_created( 'edit' ),
-					'post_type'     => 'wpi_discount',
-					'post_status'   => $this->get_post_status( $discount ),
-					'ping_status'   => 'closed',
-					'post_author'   => $discount->get_author( 'edit' ),
-					'post_title'    => $discount->get_name( 'edit' ),
-					'post_excerpt'  => $discount->get_description( 'edit' ),
-				)
-			),
-			true
-		);
-
-		if ( $id && ! is_wp_error( $id ) ) {
-			$discount->set_id( $id );
-			$this->update_post_meta( $discount );
-			$discount->save_meta_data();
-			$discount->apply_changes();
-			$this->clear_caches( $discount );
-			do_action( 'getpaid_new_discount', $discount );
-			return true;
-		}
-
-		if ( is_wp_error( $id ) ) {
-			$discount->last_error = $id->get_error_message();
-		}
-
-		return false;
-	}
-
-	/**
-	 * Method to read a discount from the database.
-	 *
-	 * @param WPInv_Discount $discount Discount object.
-	 *
-	 */
-	public function read( &$discount ) {
-
-		$discount->set_defaults();
-		$discount_object = get_post( $discount->get_id() );
-
-		if ( ! $discount->get_id() || ! $discount_object || $discount_object->post_type != 'wpi_discount' ) {
-			$discount->last_error = __( 'Invalid discount.', 'invoicing' );
-			$discount->set_id( 0 );
-			return false;
-		}
-
-		$discount->set_props(
-			array(
-				'date_created'  => 0 < $discount_object->post_date ? $discount_object->post_date : null,
-				'date_modified' => 0 < $discount_object->post_modified ? $discount_object->post_modified : null,
-				'status'        => $discount_object->post_status,
-				'name'          => $discount_object->post_title,
-				'author'        => $discount_object->post_author,
-				'description'   => $discount_object->post_excerpt,
-			)
-		);
-
-		$this->read_object_data( $discount, $discount_object );
-		$discount->read_meta_data();
-		$discount->set_object_read( true );
-		do_action( 'getpaid_read_discount', $discount );
-
-	}
-
-	/**
-	 * Method to update a discount in the database.
-	 *
-	 * @param WPInv_Discount $discount Discount object.
-	 */
-	public function update( &$discount ) {
-		$discount->save_meta_data();
-		$discount->set_version( WPINV_VERSION );
-
-		if ( null === $discount->get_date_created( 'edit' ) ) {
-			$discount->set_date_created(  current_time('mysql') );
-		}
-
-		// Grab the current status so we can compare.
-		$previous_status = get_post_status( $discount->get_id() );
-
-		$changes = $discount->get_changes();
-
-		// Only update the post when the post data changes.
-		if ( array_intersect( array( 'date_created', 'date_modified', 'status', 'name', 'author', 'post_excerpt' ), array_keys( $changes ) ) ) {
-			$post_data = array(
-				'post_date'         => $discount->get_date_created( 'edit' ),
-				'post_status'       => $discount->get_status( 'edit' ),
-				'post_title'        => $discount->get_name( 'edit' ),
-				'post_author'       => $discount->get_author( 'edit' ),
-				'post_modified'     => $discount->get_date_modified( 'edit' ),
-				'post_excerpt'      => $discount->get_description( 'edit' ),
-			);
-
-			/**
-			 * When updating this object, to prevent infinite loops, use $wpdb
-			 * to update data, since wp_update_post spawns more calls to the
-			 * save_post action.
-			 *
-			 * This ensures hooks are fired by either WP itself (admin screen save),
-			 * or an update purely from CRUD.
-			 */
-			if ( doing_action( 'save_post' ) ) {
-				$GLOBALS['wpdb']->update( $GLOBALS['wpdb']->posts, $post_data, array( 'ID' => $discount->get_id() ) );
-				clean_post_cache( $discount->get_id() );
-			} else {
-				wp_update_post( array_merge( array( 'ID' => $discount->get_id() ), $post_data ) );
-			}
-			$discount->read_meta_data( true ); // Refresh internal meta data, in case things were hooked into `save_post` or another WP hook.
-		}
-		$this->update_post_meta( $discount );
-		$discount->apply_changes();
-		$this->clear_caches( $discount );
-
-		// Fire a hook depending on the status - this should be considered a creation if it was previously draft status.
-		$new_status = $discount->get_status( 'edit' );
-
-		if ( $new_status !== $previous_status && in_array( $previous_status, array( 'new', 'auto-draft', 'draft' ), true ) ) {
-			do_action( 'getpaid_new_discount', $discount );
-		} else {
-			do_action( 'getpaid_update_discount', $discount );
-		}
-
-	}
-
-	/*
+    /**
+     * Method to create a new discount in the database.
+     *
+     * @param WPInv_Discount $discount Discount object.
+     */
+    public function create( &$discount ) {
+        $discount->set_version( WPINV_VERSION );
+        $discount->set_date_created( current_time('mysql') );
+
+        // Create a new post.
+        $id = wp_insert_post(
+            apply_filters(
+                'getpaid_new_discount_data',
+                array(
+                    'post_date'     => $discount->get_date_created( 'edit' ),
+                    'post_type'     => 'wpi_discount',
+                    'post_status'   => $this->get_post_status( $discount ),
+                    'ping_status'   => 'closed',
+                    'post_author'   => $discount->get_author( 'edit' ),
+                    'post_title'    => $discount->get_name( 'edit' ),
+                    'post_excerpt'  => $discount->get_description( 'edit' ),
+                )
+            ),
+            true
+        );
+
+        if ( $id && ! is_wp_error( $id ) ) {
+            $discount->set_id( $id );
+            $this->update_post_meta( $discount );
+            $discount->save_meta_data();
+            $discount->apply_changes();
+            $this->clear_caches( $discount );
+            do_action( 'getpaid_new_discount', $discount );
+            return true;
+        }
+
+        if ( is_wp_error( $id ) ) {
+            $discount->last_error = $id->get_error_message();
+        }
+
+        return false;
+    }
+
+    /**
+     * Method to read a discount from the database.
+     *
+     * @param WPInv_Discount $discount Discount object.
+     *
+     */
+    public function read( &$discount ) {
+
+        $discount->set_defaults();
+        $discount_object = get_post( $discount->get_id() );
+
+        if ( ! $discount->get_id() || ! $discount_object || $discount_object->post_type != 'wpi_discount' ) {
+            $discount->last_error = __( 'Invalid discount.', 'invoicing' );
+            $discount->set_id( 0 );
+            return false;
+        }
+
+        $discount->set_props(
+            array(
+                'date_created'  => 0 < $discount_object->post_date ? $discount_object->post_date : null,
+                'date_modified' => 0 < $discount_object->post_modified ? $discount_object->post_modified : null,
+                'status'        => $discount_object->post_status,
+                'name'          => $discount_object->post_title,
+                'author'        => $discount_object->post_author,
+                'description'   => $discount_object->post_excerpt,
+            )
+        );
+
+        $this->read_object_data( $discount, $discount_object );
+        $discount->read_meta_data();
+        $discount->set_object_read( true );
+        do_action( 'getpaid_read_discount', $discount );
+
+    }
+
+    /**
+     * Method to update a discount in the database.
+     *
+     * @param WPInv_Discount $discount Discount object.
+     */
+    public function update( &$discount ) {
+        $discount->save_meta_data();
+        $discount->set_version( WPINV_VERSION );
+
+        if ( null === $discount->get_date_created( 'edit' ) ) {
+            $discount->set_date_created(  current_time('mysql') );
+        }
+
+        // Grab the current status so we can compare.
+        $previous_status = get_post_status( $discount->get_id() );
+
+        $changes = $discount->get_changes();
+
+        // Only update the post when the post data changes.
+        if ( array_intersect( array( 'date_created', 'date_modified', 'status', 'name', 'author', 'post_excerpt' ), array_keys( $changes ) ) ) {
+            $post_data = array(
+                'post_date'         => $discount->get_date_created( 'edit' ),
+                'post_status'       => $discount->get_status( 'edit' ),
+                'post_title'        => $discount->get_name( 'edit' ),
+                'post_author'       => $discount->get_author( 'edit' ),
+                'post_modified'     => $discount->get_date_modified( 'edit' ),
+                'post_excerpt'      => $discount->get_description( 'edit' ),
+            );
+
+            /**
+             * When updating this object, to prevent infinite loops, use $wpdb
+             * to update data, since wp_update_post spawns more calls to the
+             * save_post action.
+             *
+             * This ensures hooks are fired by either WP itself (admin screen save),
+             * or an update purely from CRUD.
+             */
+            if ( doing_action( 'save_post' ) ) {
+                $GLOBALS['wpdb']->update( $GLOBALS['wpdb']->posts, $post_data, array( 'ID' => $discount->get_id() ) );
+                clean_post_cache( $discount->get_id() );
+            } else {
+                wp_update_post( array_merge( array( 'ID' => $discount->get_id() ), $post_data ) );
+            }
+            $discount->read_meta_data( true ); // Refresh internal meta data, in case things were hooked into `save_post` or another WP hook.
+        }
+        $this->update_post_meta( $discount );
+        $discount->apply_changes();
+        $this->clear_caches( $discount );
+
+        // Fire a hook depending on the status - this should be considered a creation if it was previously draft status.
+        $new_status = $discount->get_status( 'edit' );
+
+        if ( $new_status !== $previous_status && in_array( $previous_status, array( 'new', 'auto-draft', 'draft' ), true ) ) {
+            do_action( 'getpaid_new_discount', $discount );
+        } else {
+            do_action( 'getpaid_update_discount', $discount );
+        }
+
+    }
+
+    /*
 	|--------------------------------------------------------------------------
 	| Additional Methods
 	|--------------------------------------------------------------------------