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

Spacing +96 added lines, -96 removed lines

@@ -8,7 +8,7 @@ 
  * @version 1.0.19
  */
 
-defined( 'ABSPATH' ) || exit;
+defined('ABSPATH') || exit;
 
 /**
  * Core class to access posts via the REST API.
@@ -64,7 +64,7 @@ 
 		);
 
 		// Register REST routes.
-        add_action( 'rest_api_init', array( $this, 'register_routes' ) );
+        add_action('rest_api_init', array($this, 'register_routes'));
 
 	}
 
@@ -76,8 +76,8 @@ 
 	 */
 	public function register_routes() {
 
-		foreach ( $this->namespaces as $namespace ) {
-			$this->register_namespace_routes( $namespace );
+		foreach ($this->namespaces as $namespace) {
+			$this->register_namespace_routes($namespace);
 		}
 
 	}
@@ -89,12 +89,12 @@ 
 	 *
 	 * @param string $namespace
 	 */
-	public function register_namespace_routes( /** @scrutinizer ignore-unused */ $namespace ) {
+	public function register_namespace_routes(/** @scrutinizer ignore-unused */ $namespace) {
 
 		getpaid_doing_it_wrong(
-			__CLASS__ . '::' .__METHOD__,
+			__CLASS__ . '::' . __METHOD__,
 			/* translators: %s: register_namespace_routes() */
-			sprintf( __( "Method '%s' must be overridden." ), __METHOD__ ),
+			sprintf(__("Method '%s' must be overridden."), __METHOD__),
 			'1.0.19'
 		);
 
@@ -106,7 +106,7 @@ 
 	 * @return string
 	 */
 	protected function get_normalized_rest_base() {
-		return preg_replace( '/\(.*\)\//i', '', $this->rest_base );
+		return preg_replace('/\(.*\)\//i', '', $this->rest_base);
 	}
 
 	/**
@@ -115,11 +115,11 @@ 
 	 * @param array array of request items.
 	 * @return array
 	 */
-	protected function fill_batch_keys( $items ) {
+	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'] );
+		$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;
 
 	}
@@ -130,13 +130,13 @@ 
 	 * @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'] );
+	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 ) {
+		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 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;
@@ -150,37 +150,37 @@ 
 	 * @param WP_REST_Server $wp_rest_server
 	 * @return array()
 	 */
-	protected function batch_create_items( $items, $request, $wp_rest_server ) {
+	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' );
+		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'];
+			foreach ($schema['properties'] as $arg => $options) {
+				if (isset($options['default'])) {
+					$defaults[$arg] = $options['default'];
 				}
 			}
-			$_item->set_default_params( $defaults );
+			$_item->set_default_params($defaults);
 
 			// Set request parameters.
-			$_item->set_body_params( $item );
+			$_item->set_body_params($item);
 
 			// Set query (GET) parameters.
-			$_item->set_query_params( $query );
+			$_item->set_query_params($query);
 
 			// Create the item.
-			$_response = $this->create_item( $_item );
+			$_response = $this->create_item($_item);
 
 			// If an error occured...
-			if ( is_wp_error( $_response ) ) {
+			if (is_wp_error($_response)) {
 
-				$create[]   = array(
+				$create[] = array(
 					'id'    => 0,
 					'error' => array(
 						'code'    => $_response->get_error_code(),
@@ -192,7 +192,7 @@ 
 				continue;
 			}
 
-			$create[] = $wp_rest_server->response_to_data( /** @scrutinizer ignore-type */ $_response, false );
+			$create[] = $wp_rest_server->response_to_data(/** @scrutinizer ignore-type */ $_response, false);
 
 		}
 
@@ -208,27 +208,27 @@ 
 	 * @param WP_REST_Server $wp_rest_server
 	 * @return array()
 	 */
-	protected function batch_update_items( $items, $request, $wp_rest_server ) {
+	protected function batch_update_items($items, $request, $wp_rest_server) {
 
 		$query  = $request->get_query_params();
 		$update = array();
 
-		foreach ( $items as $item ) {
+		foreach ($items as $item) {
 
 			// Create a dummy request.
-			$_item = new WP_REST_Request( 'PUT' );
+			$_item = new WP_REST_Request('PUT');
 
 			// Add body params.
-			$_item->set_body_params( $item );
+			$_item->set_body_params($item);
 
 			// Set query (GET) parameters.
-			$_item->set_query_params( $query );
+			$_item->set_query_params($query);
 
 			// Update the item.
-			$_response = $this->update_item( $_item );
+			$_response = $this->update_item($_item);
 
 			// If an error occured...
-			if ( is_wp_error( $_response ) ) {
+			if (is_wp_error($_response)) {
 
 				$update[] = array(
 					'id'    => $item['id'],
@@ -243,7 +243,7 @@ 
 
 			}
 
-			$update[] = $wp_rest_server->response_to_data( /** @scrutinizer ignore-type */ $_response, false );
+			$update[] = $wp_rest_server->response_to_data(/** @scrutinizer ignore-type */ $_response, false);
 
 		}
 
@@ -258,14 +258,14 @@ 
 	 * @param WP_REST_Server $wp_rest_server
 	 * @return array()
 	 */
-	protected function batch_delete_items( $items, $wp_rest_server ) {
+	protected function batch_delete_items($items, $wp_rest_server) {
 
 		$delete = array();
 
-		foreach ( array_filter( $items ) as $id ) {
+		foreach (array_filter($items) as $id) {
 
 			// Prepare the request.
-			$_item = new WP_REST_Request( 'DELETE' );
+			$_item = new WP_REST_Request('DELETE');
 			$_item->set_query_params(
 				array(
 					'id'    => $id,
@@ -274,9 +274,9 @@ 
 			);
 
 			// Delete the item.
-			$_response = $this->delete_item( $_item );
+			$_response = $this->delete_item($_item);
 
-			if ( is_wp_error( $_response ) ) {
+			if (is_wp_error($_response)) {
 
 				$delete[] = array(
 					'id'    => $id,
@@ -290,7 +290,7 @@ 
 				continue;
 			}
 
-			$delete[] = $wp_rest_server->response_to_data( /** @scrutinizer ignore-type */ $_response, false );
+			$delete[] = $wp_rest_server->response_to_data(/** @scrutinizer ignore-type */ $_response, false);
 
 		}
 
@@ -304,23 +304,23 @@ 
 	 * @param WP_REST_Request $request Full details about the request.
 	 * @return WP_Error|array.
 	 */
-	public function batch_items( $request ) {
+	public function batch_items($request) {
 		global $wp_rest_server;
 
 		// Prepare the batch items.
-		$items = $this->fill_batch_keys( array_filter( $request->get_params() ) );
+		$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 ) ) {
+		$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 ),
+			'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),
 		);
 
 	}
@@ -333,8 +333,8 @@ 
 	 * @param array $meta_query Meta query.
 	 * @return array
 	 */
-	protected function add_meta_query( $args, $meta_query ) {
-		if ( empty( $args['meta_query'] ) ) {
+	protected function add_meta_query($args, $meta_query) {
+		if (empty($args['meta_query'])) {
 			$args['meta_query'] = array();
 		}
 
@@ -356,25 +356,25 @@ 
 			'type'       => 'object',
 			'properties' => array(
 				'create' => array(
-					'description' => __( 'List of created resources.', 'invoicing' ),
+					'description' => __('List of created resources.', 'invoicing'),
 					'type'        => 'array',
-					'context'     => array( 'view', 'edit' ),
+					'context'     => array('view', 'edit'),
 					'items'       => array(
 						'type'    => 'object',
 					),
 				),
 				'update' => array(
-					'description' => __( 'List of updated resources.', 'invoicing' ),
+					'description' => __('List of updated resources.', 'invoicing'),
 					'type'        => 'array',
-					'context'     => array( 'view', 'edit' ),
+					'context'     => array('view', 'edit'),
 					'items'       => array(
 						'type'    => 'object',
 					),
 				),
 				'delete' => array(
-					'description' => __( 'List of deleted resources.', 'invoicing' ),
+					'description' => __('List of deleted resources.', 'invoicing'),
 					'type'        => 'array',
-					'context'     => array( 'view', 'edit' ),
+					'context'     => array('view', 'edit'),
 					'items'       => array(
 						'type'    => 'integer',
 					),
@@ -395,13 +395,13 @@ 
 	protected function get_schema_properties() {
 
 		$schema     = $this->get_item_schema();
-		$properties = isset( $schema['properties'] ) ? $schema['properties'] : array();
+		$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;
+		foreach ($this->get_additional_fields() as $field_name => $field_options) {
+			if (is_null($field_options['schema'])) {
+				$properties[$field_name] = $field_options;
 			}
 		}
 
@@ -416,15 +416,15 @@ 
 	 * @since 1.0.19
 	 * @return array
 	 */
-	protected function filter_response_fields_by_context( $fields, $context ) {
+	protected function filter_response_fields_by_context($fields, $context) {
 
-		if ( empty( $context ) ) {
+		if (empty($context)) {
 			return $fields;
 		}
 
-		foreach ( $fields as $name => $options ) {
-			if ( ! empty( $options['context'] ) && ! in_array( $context, $options['context'], true ) ) {
-				unset( $fields[ $name ] );
+		foreach ($fields as $name => $options) {
+			if (!empty($options['context']) && !in_array($context, $options['context'], true)) {
+				unset($fields[$name]);
 			}
 		}
 
@@ -440,35 +440,35 @@ 
 	 * @since 1.0.19
 	 * @return array
 	 */
-	protected function filter_response_fields_by_array( $fields, $requested ) {
+	protected function filter_response_fields_by_array($fields, $requested) {
 
 		// Trim off any whitespace from the list array.
-		$requested = array_map( 'trim', $requested );
+		$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 ) ) {
+		if (in_array('id', $fields, true)) {
 			$requested[] = 'id';
 		}
 
 		// Get rid of duplicate fields.
-		$requested = array_unique( $requested );
+		$requested = array_unique($requested);
 
 		// Return the list of all included fields which are available.
 		return array_reduce(
 			$requested,
-			function( $response_fields, $field ) use ( $fields ) {
+			function($response_fields, $field) use ($fields) {
 
-				if ( in_array( $field, $fields, true ) ) {
+				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 );
+				$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 ) ) {
+				if (in_array($nested_fields[0], $fields, true)) {
 					$response_fields[] = $field;
 				}
 
@@ -489,23 +489,23 @@ 
 	 * @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 ) {
+	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'] );
+		$properties = $this->filter_response_fields_by_context($properties, $request['context']);
 
 		// We only need the field keys.
-		$fields = array_keys( $properties );
+		$fields = array_keys($properties);
 
 		// Is the user filtering the response fields??
-		if ( empty( $request['_fields'] ) ) {
+		if (empty($request['_fields'])) {
 			return $fields;
 		}
 
-		return $this->filter_response_fields_by_array( $fields, wpinv_parse_list( $request['_fields'] ) );
+		return $this->filter_response_fields_by_array($fields, wpinv_parse_list($request['_fields']));
 
 	}
 
@@ -519,32 +519,32 @@ 
 	 * @param array $fields Requested fields.
 	 * @return array Fields to be included in the response.
 	 */
-	public function limit_object_to_requested_fields( $data, $fields, $prefix = '' ) {
+	public function limit_object_to_requested_fields($data, $fields, $prefix = '') {
 
 		// Is the user filtering the response fields??
-		if ( empty( $fields ) ) {
+		if (empty($fields)) {
 			return $data;
 		}
 
-		foreach ( $data as $key => $value ) {
+		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 );
+			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";
+			$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 ] );
+			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 );
+			if ($key != 'meta_data' && is_array($value)) {
+				$data[$key] = $this->limit_object_to_requested_fields($value, $fields, $new_prefix);
 			}
 
 		}
@@ -566,20 +566,20 @@ 
 	 * @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 ) ) {
+	public function is_field_included($field, $fields) {
+		if (in_array($field, $fields, true)) {
 			return true;
 		}
 
-		foreach ( $fields as $accepted_field ) {
+		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 ) {
+			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 ) {
+			if (strpos($field, "$accepted_field.") === 0) {
 				return true;
 			}
 		}

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

Spacing +127 added lines, -127 removed lines

@@ -8,7 +8,7 @@ 
  * @version 1.0.19
  */
 
-defined( 'ABSPATH' ) || exit;
+defined('ABSPATH') || exit;
 
 /**
  * GetPaid REST Posts controller class.
@@ -38,9 +38,9 @@ 
 	 *
 	 * @see register_rest_route()
 	 */
-	public function register_namespace_routes( $namespace ) {
+	public function register_namespace_routes($namespace) {
 
-		parent::register_namespace_routes( $namespace );
+		parent::register_namespace_routes($namespace);
 
 		register_rest_route(
 			$namespace,
@@ -48,11 +48,11 @@ 
 			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 ),
+					'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' ),
+				'schema' => array($this, 'get_public_batch_schema'),
 			)
 		);
 
@@ -66,7 +66,7 @@ 
 	 * @param int    $object_id Post ID.
 	 * @return bool
 	 */
-	public function check_post_permissions( $context = 'read', $object_id = 0 ) {
+	public function check_post_permissions($context = 'read', $object_id = 0) {
 
 		$contexts = array(
 			'read'   => 'read_private_posts',
@@ -76,11 +76,11 @@ 
 			'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 );
+		$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 );
+		return apply_filters('getpaid_rest_check_permissions', $permission, $context, $object_id, $this->post_type);
 	}
 
 	/**
@@ -89,8 +89,8 @@ 
 	 * @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() ) );
+	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()));
 	}
 
 	/**
@@ -99,8 +99,8 @@ 
 	 * @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() ) );
+	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()));
 	}
 
 	/**
@@ -109,11 +109,11 @@ 
 	 * @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'] );
+	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() ) );
+		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;
@@ -125,11 +125,11 @@ 
 	 * @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'] );
+	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() ) );
+		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;
@@ -141,11 +141,11 @@ 
 	 * @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'] );
+	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() ) );
+		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;
@@ -158,15 +158,15 @@ 
 	 *
 	 * @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() ) );
+	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 );
+	public function get_post($object_id) {
+		return $this->get_object($object_id);
     }
 
 	/**
@@ -175,14 +175,14 @@ 
 	 * @param WP_REST_Request $request Full details about the request.
 	 * @return WP_Error|WP_REST_Response
 	 */
-	public function get_item( $request ) {
+	public function get_item($request) {
 
 		// Fetch item.
-		$response = parent::get_item( $request );
+		$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' ) );
+		if ($this->public && !is_wp_error($response)) {
+			$response->link_header('alternate', get_permalink($this->data_object->get_id()), array('type' => 'text/html'));
 		}
 
 		return $response;
@@ -194,13 +194,13 @@ 
 	 * @param WP_REST_Request $request Full details about the request.
 	 * @return WP_Error|WP_REST_Response
 	 */
-	public function create_item( $request ) {
+	public function create_item($request) {
 
 		// Create item.
-		$response = parent::create_item( $request );
+		$response = parent::create_item($request);
 
 		// Fire a hook after an item is created.
-		if ( ! is_wp_error( $response ) ) {
+		if (!is_wp_error($response)) {
 
 			/**
 			 * Fires after a single item is created or updated via the REST API.
@@ -209,7 +209,7 @@ 
 			 * @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 );
+			do_action("getpaid_rest_insert_{$this->post_type}", $this->data_object, $request, true);
 
 		}
 
@@ -223,13 +223,13 @@ 
 	 * @param WP_REST_Request $request Full details about the request.
 	 * @return WP_Error|WP_REST_Response
 	 */
-	public function update_item( $request ) {
+	public function update_item($request) {
 
 		// Create item.
-		$response = parent::update_item( $request );
+		$response = parent::update_item($request);
 
 		// Fire a hook after an item is created.
-		if ( ! is_wp_error( $response ) ) {
+		if (!is_wp_error($response)) {
 
 			/**
 			 * Fires after a single item is created or updated via the REST API.
@@ -238,7 +238,7 @@ 
 			 * @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 );
+			do_action("getpaid_rest_insert_{$this->post_type}", $this->data_object, $request, false);
 
 		}
 
@@ -252,7 +252,7 @@ 
 	 * @param WP_REST_Request $request Full details about the request.
 	 * @return WP_Error|WP_REST_Response
 	 */
-	public function get_items( $request ) {
+	public function get_items($request) {
 
 		$args                         = array();
 		$args['offset']               = $request['offset'];
@@ -266,17 +266,17 @@ 
 		$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['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'] ) ) {
+		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'] ) ) {
+		if (isset($request['after'])) {
 			$args['date_query'][0]['after'] = $request['after'];
 		}
 
@@ -285,54 +285,54 @@ 
 		$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 );
+		$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 );
+		$query_result = $posts_query->query($query_args);
 
 		$posts = array();
-		foreach ( $query_result as $post_id ) {
-			if ( ! $this->check_post_permissions( 'read', $post_id ) ) {
+		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 );
+			$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 ) {
+		if ($total_posts < 1) {
 			// Out-of-bounds, run the query again without LIMIT for total count.
-			unset( $query_args['paged'] );
+			unset($query_args['paged']);
 			$count_query = new WP_Query();
-			$count_query->query( $query_args );
+			$count_query->query($query_args);
 			$total_posts = $count_query->found_posts;
 		}
 
-		$max_pages = ceil( $total_posts / (int) $query_args['posts_per_page'] );
+		$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 );
+		$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 ) ) );
+		$base = add_query_arg($request_params, rest_url(sprintf('/%s/%s', $this->namespace, $this->rest_base)));
 
-		if ( $page > 1 ) {
+		if ($page > 1) {
 			$prev_page = $page - 1;
-			if ( $prev_page > $max_pages ) {
+			if ($prev_page > $max_pages) {
 				$prev_page = $max_pages;
 			}
-			$prev_link = add_query_arg( 'page', $prev_page, $base );
-			$response->link_header( 'prev', $prev_link );
+			$prev_link = add_query_arg('page', $prev_page, $base);
+			$response->link_header('prev', $prev_link);
 		}
-		if ( $max_pages > $page ) {
+		if ($max_pages > $page) {
 			$next_page = $page + 1;
-			$next_link = add_query_arg( 'page', $next_page, $base );
-			$response->link_header( 'next', $next_link );
+			$next_link = add_query_arg('page', $next_page, $base);
+			$response->link_header('next', $next_link);
 		}
 
 		return $response;
@@ -344,26 +344,26 @@ 
 	 * @param WP_REST_Request $request Full details about the request.
 	 * @return WP_REST_Response|WP_Error
 	 */
-	public function delete_item( $request ) {
+	public function delete_item($request) {
 
 		// Fetch the item.
-		$item = $this->get_object( $request['id'] );
-		if ( is_wp_error( $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() ) );
+		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 );
+		$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 ) );
+		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;
@@ -375,27 +375,27 @@ 
 	 * @param GetPaid_Data    $object GetPaid_Data object.
 	 * @return array Links for the given object.
 	 */
-	protected function prepare_links( $object ) {
+	protected function prepare_links($object) {
 
-		$links = parent::prepare_links( $object );
+		$links = parent::prepare_links($object);
 
-		if ( is_callable( array( $object, 'get_user_id' ) ) ) {
+		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' )  ) ),
+				'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' )  ) ),
+		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' )  ) ),
+		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,
 			);
 		}
@@ -411,27 +411,27 @@ 
 	 * @param WP_REST_Request $request Request object.
 	 * @return array          $query_args
 	 */
-	protected function prepare_items_query( $prepared_args = array(), $request = null ) {
+	protected function prepare_items_query($prepared_args = array(), $request = null) {
 
-		$valid_vars = array_flip( $this->get_allowed_query_vars() );
+		$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 );
+		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'] ) {
+		if ('include' === $query_args['orderby']) {
 			$query_args['orderby'] = 'post__in';
-		} elseif ( 'id' === $query_args['orderby'] ) {
+		} elseif ('id' === $query_args['orderby']) {
 			$query_args['orderby'] = 'ID'; // ID must be capitalized.
-		} elseif ( 'slug' === $query_args['orderby'] ) {
+		} elseif ('slug' === $query_args['orderby']) {
 			$query_args['orderby'] = 'name';
 		}
 
-		return apply_filters( 'getpaid_rest_prepare_items_query', $query_args, $request, $this );
+		return apply_filters('getpaid_rest_prepare_items_query', $query_args, $request, $this);
 
 	}
 
@@ -450,12 +450,12 @@ 
 		 *
 		 * @param array  Array of allowed WP_Query query vars.
 		 */
-		$valid_vars = apply_filters( 'query_vars', $wp->public_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 );
+		$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.
@@ -477,10 +477,10 @@ 
 			'meta_compare',
 			'meta_value_num',
 		);
-		$valid_vars = array_merge( $valid_vars, $rest_valid );
+		$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 );
+		$valid_vars = apply_filters('getpaid_rest_query_vars', $valid_vars, $this);
 
 		return $valid_vars;
 	}
@@ -499,31 +499,31 @@ 
 			array(
 				'status' => array(
 					'default'           => $this->get_post_statuses(),
-					'description'       => __( 'Limit result set to resources assigned one or more statuses.', 'invoicing' ),
-					'type'              => array( 'array', 'string' ),
+					'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' ),
+					'sanitize_callback' => array($this, 'sanitize_post_statuses'),
 				),
 				'after' => array(
-					'description'        => __( 'Limit response to resources created after a given ISO8601 compliant date.', 'invoicing' ),
+					'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' ),
+					'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' ),
+					'description'       => __('Ensure result set excludes specific IDs.', 'invoicing'),
 					'type'              => 'array',
 					'items'             => array(
 						'type'          => 'integer',
@@ -533,7 +533,7 @@ 
 					'validate_callback' => 'rest_validate_request_arg',
 				),
 				'include' => array(
-					'description'       => __( 'Limit result set to specific ids.', 'invoicing' ),
+					'description'       => __('Limit result set to specific ids.', 'invoicing'),
 					'type'              => 'array',
 					'items'             => array(
 						'type'          => 'integer',
@@ -543,20 +543,20 @@ 
 					'validate_callback' => 'rest_validate_request_arg',
 				),
 				'offset' => array(
-					'description'        => __( 'Offset the result set by a specific number of items.', 'invoicing' ),
+					'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' ),
+					'description'        => __('Order sort attribute ascending or descending.', 'invoicing'),
 					'type'               => 'string',
 					'default'            => 'desc',
-					'enum'               => array( 'asc', 'desc' ),
+					'enum'               => array('asc', 'desc'),
 					'validate_callback'  => 'rest_validate_request_arg',
 				),
 				'orderby' => array(
-					'description'        => __( 'Sort collection by object attribute.', 'invoicing' ),
+					'description'        => __('Sort collection by object attribute.', 'invoicing'),
 					'type'               => 'string',
 					'default'            => 'date',
 					'enum'               => array(
@@ -583,25 +583,25 @@ 
 	public function get_item_schema() {
 
 		// Maybe retrieve the schema from cache.
-		if ( ! empty( $this->schema ) ) {
-			return $this->add_additional_fields_schema( $this->schema );
+		if (!empty($this->schema)) {
+			return $this->add_additional_fields_schema($this->schema);
 		}
 
-		$type   = str_replace( 'wpi_', '', $this->post_type );
+		$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" ),
+			'properties' => wpinv_get_data("$type-schema"),
 		);
 
 		// Filters the invoice schema for the REST API.
-        $schema = apply_filters( "wpinv_rest_{$type}_schema", $schema );
+        $schema = apply_filters("wpinv_rest_{$type}_schema", $schema);
 
 		// Cache the invoice schema.
 		$this->schema = $schema;
 
-		return $this->add_additional_fields_schema( $this->schema );
+		return $this->add_additional_fields_schema($this->schema);
 	}
 
 	/**
@@ -614,8 +614,8 @@ 
 	 * @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() );
+	public function sanitize_post_statuses($statuses, $request, $parameter) {
+		return array_intersect(wp_parse_slug_list($statuses), $this->get_post_statuses());
 	}
 
 	/**
@@ -637,9 +637,9 @@ 
 	 * @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 );
+	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/admin/class-wpinv-subscriptions-list-table.php

Braces +3 added lines, -1 removed lines

@@ -3,7 +3,9 @@
  * Displays a list of all subscriptions rules
  */
 
-if ( ! defined( 'ABSPATH' ) ) exit;
+if ( ! defined( 'ABSPATH' ) ) {
+    exit;
+}
 
 if ( ! class_exists( 'WP_List_Table' ) ) {
 	include_once ABSPATH . 'wp-admin/includes/class-wp-list-table.php';

Indentation +463 added lines, -463 removed lines

@@ -6,7 +6,7 @@ 
 if ( ! defined( 'ABSPATH' ) ) exit;
 
 if ( ! class_exists( 'WP_List_Table' ) ) {
-	include_once ABSPATH . 'wp-admin/includes/class-wp-list-table.php';
+    include_once ABSPATH . 'wp-admin/includes/class-wp-list-table.php';
 }
 
 /**
@@ -14,467 +14,467 @@ 
  */
 class WPInv_Subscriptions_List_Table extends WP_List_Table {
 
-	/**
-	 * URL of this page
-	 *
-	 * @var   string
-	 * @since 1.0.19
-	 */
-	public $base_url;
-
-	/**
-	 * Query
-	 *
-	 * @var   GetPaid_Subscriptions_Query
-	 * @since 1.0.19
-	 */
-	public $query;
-
-	/**
-	 * Total subscriptions
-	 *
-	 * @var   string
-	 * @since 1.0.0
-	 */
-	public $total_count;
-
-	/**
-	 * Current status subscriptions
-	 *
-	 * @var   string
-	 * @since 1.0.0
-	 */
-	public $current_total_count;
-
-	/**
-	 * Status counts
-	 *
-	 * @var   array
-	 * @since 1.0.19
-	 */
-	public $status_counts;
-
-	/**
-	 * Number of results to show per page
-	 *
-	 * @var   int
-	 * @since 1.0.0
-	 */
-	public $per_page = 10;
-
-	/**
-	 *  Constructor function.
-	 */
-	public function __construct() {
-
-		parent::__construct(
-			array(
-				'singular' => 'subscription',
-				'plural'   => 'subscriptions',
-			)
-		);
-
-		$this->process_bulk_action();
-
-		$this->prepare_query();
-
-		$this->base_url = remove_query_arg( 'status' );
-
-	}
-
-	/**
-	 *  Prepares the display query
-	 */
-	public function prepare_query() {
-
-		// Prepare query args.
-		$query = array(
-			'number'  => $this->per_page,
-			'paged'   => $this->get_paged(),
-			'status'  => ( isset( $_GET['status'] ) && array_key_exists( $_GET['status'], getpaid_get_subscription_statuses() ) ) ? sanitize_text_field( $_GET['status'] ) : 'all',
-			'orderby' => ( isset( $_GET['orderby'] ) ) ? sanitize_text_field( $_GET['orderby'] ) : 'id',
-			'order'   => ( isset( $_GET['order'] ) ) ? sanitize_text_field( $_GET['order'] ) : 'DESC',
-			'customer_in' => $this->get_user_in(),
-		);
-
-		if ( is_array( $query['customer_in'] ) && empty( $query['customer_in'] ) ) {
-			$this->total_count         = 0;
-			$this->current_total_count = 0;
-			$this->items               = array();
-			$this->status_counts       = array();
-			return;
-		}
-
-		// Prepare class properties.
-		$this->query               = new GetPaid_Subscriptions_Query( $query );
-		$this->total_count         = $this->query->get_total();
-		$this->current_total_count = $this->query->get_total();
-		$this->items               = $this->query->get_results();
-		$this->status_counts       = getpaid_get_subscription_status_counts( $query );
-
-		if ( 'all' != $query['status'] ) {
-			unset( $query['status'] );
-			$this->total_count   = getpaid_get_subscriptions( $query, 'count' );
-		}
-
-	}
-
-	/**
-	 * Get user in.
-	 *
-	 */
-	public function get_user_in() {
-
-		// Abort if no user.
-		if ( empty( $_GET['s'] ) ) {
-			return null;
-		}
-
-		// Or invalid user.
-		$user = wp_unslash( sanitize_text_field( $_REQUEST['s'] ) );
-
-		if ( empty( $user ) ) {
-			return null;
-		}
-
-		// Search matching users.
-		$user  = '*' . $user . '*';
-		$users = new WP_User_Query(
-			array(
-				'fields'      => 'ID',
-				'search'      => $user,
-				'count_total' => false,
-			)
-		);
-
-		return $users->get_results();
-	}
-
-	/**
-	 * Gets the list of views available on this table.
-	 *
-	 * The format is an associative array:
-	 * - `'id' => 'link'`
-	 *
-	 * @since 1.0.0
-	 *
-	 * @return array
-	 */
-	public function get_views() {
-
-		$current  = isset( $_GET['status'] ) ? sanitize_text_field( $_GET['status'] ) : 'all';
-		$views    = array(
-
-			'all' => sprintf(
-				'<a href="%s" %s>%s&nbsp;<span class="count">(%d)</span></a>',
-				esc_url( add_query_arg( 'status', false, $this->base_url ) ),
-				$current === 'all' ? ' class="current"' : '',
-				__('All','invoicing' ),
-				$this->total_count
-			)
-
-		);
-
-		foreach ( array_filter( $this->status_counts ) as $status => $count ) {
-
-			$views[ $status ] = sprintf(
-				'<a href="%s" %s>%s&nbsp;<span class="count">(%d)</span></a>',
-				esc_url( add_query_arg( 'status', urlencode( $status ), $this->base_url ) ),
-				$current === $status ? ' class="current"' : '',
-				esc_html( getpaid_get_subscription_status_label( $status ) ),
-				$count
-			);
-
-		}
-
-		return $views;
-
-	}
-
-	/**
-	 * Render most columns
-	 *
-	 * @access      private
-	 * @since       1.0.0
-	 * @return      string
-	 */
-	public function column_default( $item, $column_name ) {
-		return apply_filters( "getpaid_subscriptions_table_column_$column_name", $item->$column_name );
-	}
-
-	/**
-	 * This is how checkbox column renders.
-	 *
-	 * @param WPInv_Subscription $item
-	 * @return string
-	 */
-	public function column_cb( $item ) {
-		return sprintf( '<input type="checkbox" name="id[]" value="%s" />', esc_html( $item->get_id() ) );
-	}
-
-	/**
-	 * Status column
-	 *
-	 * @param WPInv_Subscription $item
-	 * @since       1.0.0
-	 * @return      string
-	 */
-	public function column_status( $item ) {
-		return $item->get_status_label_html();
-	}
-
-	/**
-	 * Subscription column
-	 *
-	 * @param WPInv_Subscription $item
-	 * @since       1.0.0
-	 * @return      string
-	 */
-	public function column_subscription( $item ) {
-
-		$username = __( '(Missing User)', 'invoicing' );
-
-		$user = get_userdata( $item->get_customer_id() );
-		if ( $user ) {
-
-			$username = sprintf(
-				'<a href="user-edit.php?user_id=%s">%s</a>',
-				absint( $user->ID ),
-				! empty( $user->display_name ) ? esc_html( $user->display_name ) : sanitize_email( $user->user_email )
-			);
-
-		}
-
-		// translators: $1: is opening link, $2: is subscription id number, $3: is closing link tag, $4: is user's name
-		$column_content = sprintf(
-			_x( '%1$s#%2$s%3$s for %4$s', 'Subscription title on admin table. (e.g.: #211 for John Doe)', 'invoicing' ),
-			'<a href="' . esc_url( admin_url( 'admin.php?page=wpinv-subscriptions&id=' . absint( $item->get_id() ) ) ) . '">',
-			'<strong>' . esc_attr( $item->get_id() ) . '</strong>', '</a>',
-			$username
-		);
-
-		$row_actions = array();
-
-		// View subscription.
-		$view_url    = esc_url( add_query_arg( 'id', $item->get_id(), admin_url( 'admin.php?page=wpinv-subscriptions' ) ));
-		$row_actions['view'] = '<a href="' . $view_url . '">' . __( 'View Subscription', 'invoicing' ) . '</a>';
-
-		// View invoice.
-		$invoice = get_post( $item->get_parent_invoice_id() );
-
-		if ( ! empty( $invoice ) ) {
-			$invoice_url            = get_edit_post_link( $invoice );
-			$row_actions['invoice'] = '<a href="' . $invoice_url . '">' . __( 'View Invoice', 'invoicing' ) . '</a>';
-		}
-
-		$delete_url            = esc_url(
-			wp_nonce_url(
-				add_query_arg(
-					array(
-						'getpaid-admin-action' => 'subscription_manual_delete',
-						'id'                   => $item->get_id(),
-					)
-				),
-				'getpaid-nonce',
-				'getpaid-nonce'
-			)
-		);
-		$row_actions['delete'] = '<a class="text-danger" href="' . $delete_url . '">' . __( 'Delete Subscription', 'invoicing' ) . '</a>';
-
-		$row_actions = $this->row_actions( apply_filters( 'getpaid_subscription_table_row_actions', $row_actions, $item ) );
-
-		return "<strong>$column_content</strong>" . $this->column_amount( $item ) . $row_actions;
-	}
-
-	/**
-	 * Renewal date column
-	 *
-	 * @param WPInv_Subscription $item
-	 * @since       1.0.0
-	 * @return      string
-	 */
-	public function column_renewal_date( $item ) {
-		return getpaid_format_date_value( $item->get_expiration() );
-	}
-
-	/**
-	 * Start date column
-	 *
-	 * @param WPInv_Subscription $item
-	 * @since       1.0.0
-	 * @return      string
-	 */
-	public function column_start_date( $item ) {
-
-		$gateway = $item->get_parent_invoice()->get_gateway_title();
-
-		if ( empty( $gateway ) ) {
-			return getpaid_format_date_value( $item->get_date_created() );
-		}
-
-		$url = apply_filters( 'getpaid_remote_subscription_profile_url', '', $item );
-		if ( ! empty( $url ) ) {
-
-			return getpaid_format_date_value( $item->get_date_created() ) . '<br>' . sprintf(
-				__( 'Via %s', 'invoicing' ),
-				'<strong><a href="' . esc_url( $url ) . '" target="_blank">' . esc_html( $item->get_parent_invoice()->get_gateway_title() ) . '</a></strong>'
-			);
-
-		}
-
-		return getpaid_format_date_value( $item->get_date_created() ) . '<br>' . sprintf(
-			__( 'Via %s', 'invoicing' ),
-			'<strong>' . esc_html( $item->get_parent_invoice()->get_gateway_title() ) . '</strong>'
-		);
-
-	}
-
-	/**
-	 * Amount column
-	 *
-	 * @param WPInv_Subscription $item
-	 * @since       1.0.19
-	 * @return      string
-	 */
-	public static function column_amount( $item ) {
-		$amount = getpaid_get_formatted_subscription_amount( $item );
-		return "<span class='text-muted form-text mt-2 mb-2'>$amount</span>";
-	}
-
-	/**
-	 * Billing Times column
-	 *
-	 * @param WPInv_Subscription $item
-	 * @since       1.0.0
-	 * @return      string
-	 */
-	public function column_renewals( $item ) {
-		$max_bills = $item->get_bill_times();
-		return $item->get_times_billed() . ' / ' . ( empty( $max_bills ) ? "&infin;" : $max_bills );
-	}
-
-	/**
-	 * Product ID column
-	 *
-	 * @param WPInv_Subscription $item
-	 * @since       1.0.0
-	 * @return      string
-	 */
-	public function column_item( $item ) {
-		$subscription_group = getpaid_get_invoice_subscription_group( $item->get_parent_invoice_id(), $item->get_id() );
-
-		if ( empty( $subscription_group ) ) {
-			return $this->generate_item_markup( $item->get_product_id() );
-		}
-
-		$markup = array_map( array( $this, 'generate_item_markup' ), array_keys( $subscription_group['items'] ) );
-		return implode( ' | ', $markup );
-
-	}
-
-	/**
-	 * Generates the items markup.
-	 *
-	 * @param int $item_id
-	 * @since       1.0.0
-	 * @return      string
-	 */
-	public static function generate_item_markup( $item_id ) {
-		$item = get_post( $item_id );
-
-		if ( ! empty( $item ) ) {
-			$link = get_edit_post_link( $item );
-			$link = esc_url( $link );
-			$name = esc_html( get_the_title( $item ) );
-			return wpinv_current_user_can_manage_invoicing() ? "<a href='$link'>$name</a>" : $name;
-		} else {
-			return sprintf( __( 'Item #%s', 'invoicing' ), $item_id );
-		}
-
-	}
-
-	/**
-	 * Retrieve the current page number
-	 *
-	 * @return      int
-	 */
-	public function get_paged() {
-		return isset( $_GET['paged'] ) ? absint( $_GET['paged'] ) : 1;
-	}
-
-	/**
-	 * Setup the final data for the table
-	 *
-	 */
-	public function prepare_items() {
-
-		$columns  = $this->get_columns();
-		$hidden   = array();
-		$sortable = $this->get_sortable_columns();
-
-		$this->_column_headers = array( $columns, $hidden, $sortable );
-
-		$this->set_pagination_args(
-			array(
-			'total_items' => $this->current_total_count,
-			'per_page'    => $this->per_page,
-			'total_pages' => ceil( $this->current_total_count / $this->per_page )
-			)
-		);
-	}
-
-	/**
-	 * Table columns
-	 *
-	 * @return array
-	 */
-	public function get_columns(){
-		$columns = array(
-			'cb'                => '<input type="checkbox" />',
-			'subscription'      => __( 'Subscription', 'invoicing' ),
-			'start_date'        => __( 'Start Date', 'invoicing' ),
-			'renewal_date'      => __( 'Next Payment', 'invoicing' ),
-			'renewals'          => __( 'Payments', 'invoicing' ),
-			'item'              => __( 'Items', 'invoicing' ),
-			'status'            => __( 'Status', 'invoicing' ),
-		);
-
-		return apply_filters( 'manage_getpaid_subscriptions_table_columns', $columns );
-	}
-
-	/**
-	 * Sortable table columns.
-	 *
-	 * @return array
-	 */
-	public function get_sortable_columns() {
-		$sortable = array(
-			'subscription' => array( 'id', true ),
-			'start_date'   => array( 'created', true ),
-			'renewal_date' => array( 'expiration', true ),
-			'renewals'     => array( 'bill_times', true ),
-			'item'         => array( 'product_id', true ),
-			'status'       => array( 'status', true ),
-		);
-
-		return apply_filters( 'manage_getpaid_subscriptions_sortable_table_columns', $sortable );
-	}
-
-	/**
-	 * Whether the table has items to display or not
-	 *
-	 * @return bool
-	 */
-	public function has_items() {
-		return ! empty( $this->current_total_count );
-	}
-
-	/**
-	 * Processes bulk actions.
-	 *
-	 */
-	public function process_bulk_action() {
-
-	}
+    /**
+     * URL of this page
+     *
+     * @var   string
+     * @since 1.0.19
+     */
+    public $base_url;
+
+    /**
+     * Query
+     *
+     * @var   GetPaid_Subscriptions_Query
+     * @since 1.0.19
+     */
+    public $query;
+
+    /**
+     * Total subscriptions
+     *
+     * @var   string
+     * @since 1.0.0
+     */
+    public $total_count;
+
+    /**
+     * Current status subscriptions
+     *
+     * @var   string
+     * @since 1.0.0
+     */
+    public $current_total_count;
+
+    /**
+     * Status counts
+     *
+     * @var   array
+     * @since 1.0.19
+     */
+    public $status_counts;
+
+    /**
+     * Number of results to show per page
+     *
+     * @var   int
+     * @since 1.0.0
+     */
+    public $per_page = 10;
+
+    /**
+     *  Constructor function.
+     */
+    public function __construct() {
+
+        parent::__construct(
+            array(
+                'singular' => 'subscription',
+                'plural'   => 'subscriptions',
+            )
+        );
+
+        $this->process_bulk_action();
+
+        $this->prepare_query();
+
+        $this->base_url = remove_query_arg( 'status' );
+
+    }
+
+    /**
+     *  Prepares the display query
+     */
+    public function prepare_query() {
+
+        // Prepare query args.
+        $query = array(
+            'number'  => $this->per_page,
+            'paged'   => $this->get_paged(),
+            'status'  => ( isset( $_GET['status'] ) && array_key_exists( $_GET['status'], getpaid_get_subscription_statuses() ) ) ? sanitize_text_field( $_GET['status'] ) : 'all',
+            'orderby' => ( isset( $_GET['orderby'] ) ) ? sanitize_text_field( $_GET['orderby'] ) : 'id',
+            'order'   => ( isset( $_GET['order'] ) ) ? sanitize_text_field( $_GET['order'] ) : 'DESC',
+            'customer_in' => $this->get_user_in(),
+        );
+
+        if ( is_array( $query['customer_in'] ) && empty( $query['customer_in'] ) ) {
+            $this->total_count         = 0;
+            $this->current_total_count = 0;
+            $this->items               = array();
+            $this->status_counts       = array();
+            return;
+        }
+
+        // Prepare class properties.
+        $this->query               = new GetPaid_Subscriptions_Query( $query );
+        $this->total_count         = $this->query->get_total();
+        $this->current_total_count = $this->query->get_total();
+        $this->items               = $this->query->get_results();
+        $this->status_counts       = getpaid_get_subscription_status_counts( $query );
+
+        if ( 'all' != $query['status'] ) {
+            unset( $query['status'] );
+            $this->total_count   = getpaid_get_subscriptions( $query, 'count' );
+        }
+
+    }
+
+    /**
+     * Get user in.
+     *
+     */
+    public function get_user_in() {
+
+        // Abort if no user.
+        if ( empty( $_GET['s'] ) ) {
+            return null;
+        }
+
+        // Or invalid user.
+        $user = wp_unslash( sanitize_text_field( $_REQUEST['s'] ) );
+
+        if ( empty( $user ) ) {
+            return null;
+        }
+
+        // Search matching users.
+        $user  = '*' . $user . '*';
+        $users = new WP_User_Query(
+            array(
+                'fields'      => 'ID',
+                'search'      => $user,
+                'count_total' => false,
+            )
+        );
+
+        return $users->get_results();
+    }
+
+    /**
+     * Gets the list of views available on this table.
+     *
+     * The format is an associative array:
+     * - `'id' => 'link'`
+     *
+     * @since 1.0.0
+     *
+     * @return array
+     */
+    public function get_views() {
+
+        $current  = isset( $_GET['status'] ) ? sanitize_text_field( $_GET['status'] ) : 'all';
+        $views    = array(
+
+            'all' => sprintf(
+                '<a href="%s" %s>%s&nbsp;<span class="count">(%d)</span></a>',
+                esc_url( add_query_arg( 'status', false, $this->base_url ) ),
+                $current === 'all' ? ' class="current"' : '',
+                __('All','invoicing' ),
+                $this->total_count
+            )
+
+        );
+
+        foreach ( array_filter( $this->status_counts ) as $status => $count ) {
+
+            $views[ $status ] = sprintf(
+                '<a href="%s" %s>%s&nbsp;<span class="count">(%d)</span></a>',
+                esc_url( add_query_arg( 'status', urlencode( $status ), $this->base_url ) ),
+                $current === $status ? ' class="current"' : '',
+                esc_html( getpaid_get_subscription_status_label( $status ) ),
+                $count
+            );
+
+        }
+
+        return $views;
+
+    }
+
+    /**
+     * Render most columns
+     *
+     * @access      private
+     * @since       1.0.0
+     * @return      string
+     */
+    public function column_default( $item, $column_name ) {
+        return apply_filters( "getpaid_subscriptions_table_column_$column_name", $item->$column_name );
+    }
+
+    /**
+     * This is how checkbox column renders.
+     *
+     * @param WPInv_Subscription $item
+     * @return string
+     */
+    public function column_cb( $item ) {
+        return sprintf( '<input type="checkbox" name="id[]" value="%s" />', esc_html( $item->get_id() ) );
+    }
+
+    /**
+     * Status column
+     *
+     * @param WPInv_Subscription $item
+     * @since       1.0.0
+     * @return      string
+     */
+    public function column_status( $item ) {
+        return $item->get_status_label_html();
+    }
+
+    /**
+     * Subscription column
+     *
+     * @param WPInv_Subscription $item
+     * @since       1.0.0
+     * @return      string
+     */
+    public function column_subscription( $item ) {
+
+        $username = __( '(Missing User)', 'invoicing' );
+
+        $user = get_userdata( $item->get_customer_id() );
+        if ( $user ) {
+
+            $username = sprintf(
+                '<a href="user-edit.php?user_id=%s">%s</a>',
+                absint( $user->ID ),
+                ! empty( $user->display_name ) ? esc_html( $user->display_name ) : sanitize_email( $user->user_email )
+            );
+
+        }
+
+        // translators: $1: is opening link, $2: is subscription id number, $3: is closing link tag, $4: is user's name
+        $column_content = sprintf(
+            _x( '%1$s#%2$s%3$s for %4$s', 'Subscription title on admin table. (e.g.: #211 for John Doe)', 'invoicing' ),
+            '<a href="' . esc_url( admin_url( 'admin.php?page=wpinv-subscriptions&id=' . absint( $item->get_id() ) ) ) . '">',
+            '<strong>' . esc_attr( $item->get_id() ) . '</strong>', '</a>',
+            $username
+        );
+
+        $row_actions = array();
+
+        // View subscription.
+        $view_url    = esc_url( add_query_arg( 'id', $item->get_id(), admin_url( 'admin.php?page=wpinv-subscriptions' ) ));
+        $row_actions['view'] = '<a href="' . $view_url . '">' . __( 'View Subscription', 'invoicing' ) . '</a>';
+
+        // View invoice.
+        $invoice = get_post( $item->get_parent_invoice_id() );
+
+        if ( ! empty( $invoice ) ) {
+            $invoice_url            = get_edit_post_link( $invoice );
+            $row_actions['invoice'] = '<a href="' . $invoice_url . '">' . __( 'View Invoice', 'invoicing' ) . '</a>';
+        }
+
+        $delete_url            = esc_url(
+            wp_nonce_url(
+                add_query_arg(
+                    array(
+                        'getpaid-admin-action' => 'subscription_manual_delete',
+                        'id'                   => $item->get_id(),
+                    )
+                ),
+                'getpaid-nonce',
+                'getpaid-nonce'
+            )
+        );
+        $row_actions['delete'] = '<a class="text-danger" href="' . $delete_url . '">' . __( 'Delete Subscription', 'invoicing' ) . '</a>';
+
+        $row_actions = $this->row_actions( apply_filters( 'getpaid_subscription_table_row_actions', $row_actions, $item ) );
+
+        return "<strong>$column_content</strong>" . $this->column_amount( $item ) . $row_actions;
+    }
+
+    /**
+     * Renewal date column
+     *
+     * @param WPInv_Subscription $item
+     * @since       1.0.0
+     * @return      string
+     */
+    public function column_renewal_date( $item ) {
+        return getpaid_format_date_value( $item->get_expiration() );
+    }
+
+    /**
+     * Start date column
+     *
+     * @param WPInv_Subscription $item
+     * @since       1.0.0
+     * @return      string
+     */
+    public function column_start_date( $item ) {
+
+        $gateway = $item->get_parent_invoice()->get_gateway_title();
+
+        if ( empty( $gateway ) ) {
+            return getpaid_format_date_value( $item->get_date_created() );
+        }
+
+        $url = apply_filters( 'getpaid_remote_subscription_profile_url', '', $item );
+        if ( ! empty( $url ) ) {
+
+            return getpaid_format_date_value( $item->get_date_created() ) . '<br>' . sprintf(
+                __( 'Via %s', 'invoicing' ),
+                '<strong><a href="' . esc_url( $url ) . '" target="_blank">' . esc_html( $item->get_parent_invoice()->get_gateway_title() ) . '</a></strong>'
+            );
+
+        }
+
+        return getpaid_format_date_value( $item->get_date_created() ) . '<br>' . sprintf(
+            __( 'Via %s', 'invoicing' ),
+            '<strong>' . esc_html( $item->get_parent_invoice()->get_gateway_title() ) . '</strong>'
+        );
+
+    }
+
+    /**
+     * Amount column
+     *
+     * @param WPInv_Subscription $item
+     * @since       1.0.19
+     * @return      string
+     */
+    public static function column_amount( $item ) {
+        $amount = getpaid_get_formatted_subscription_amount( $item );
+        return "<span class='text-muted form-text mt-2 mb-2'>$amount</span>";
+    }
+
+    /**
+     * Billing Times column
+     *
+     * @param WPInv_Subscription $item
+     * @since       1.0.0
+     * @return      string
+     */
+    public function column_renewals( $item ) {
+        $max_bills = $item->get_bill_times();
+        return $item->get_times_billed() . ' / ' . ( empty( $max_bills ) ? "&infin;" : $max_bills );
+    }
+
+    /**
+     * Product ID column
+     *
+     * @param WPInv_Subscription $item
+     * @since       1.0.0
+     * @return      string
+     */
+    public function column_item( $item ) {
+        $subscription_group = getpaid_get_invoice_subscription_group( $item->get_parent_invoice_id(), $item->get_id() );
+
+        if ( empty( $subscription_group ) ) {
+            return $this->generate_item_markup( $item->get_product_id() );
+        }
+
+        $markup = array_map( array( $this, 'generate_item_markup' ), array_keys( $subscription_group['items'] ) );
+        return implode( ' | ', $markup );
+
+    }
+
+    /**
+     * Generates the items markup.
+     *
+     * @param int $item_id
+     * @since       1.0.0
+     * @return      string
+     */
+    public static function generate_item_markup( $item_id ) {
+        $item = get_post( $item_id );
+
+        if ( ! empty( $item ) ) {
+            $link = get_edit_post_link( $item );
+            $link = esc_url( $link );
+            $name = esc_html( get_the_title( $item ) );
+            return wpinv_current_user_can_manage_invoicing() ? "<a href='$link'>$name</a>" : $name;
+        } else {
+            return sprintf( __( 'Item #%s', 'invoicing' ), $item_id );
+        }
+
+    }
+
+    /**
+     * Retrieve the current page number
+     *
+     * @return      int
+     */
+    public function get_paged() {
+        return isset( $_GET['paged'] ) ? absint( $_GET['paged'] ) : 1;
+    }
+
+    /**
+     * Setup the final data for the table
+     *
+     */
+    public function prepare_items() {
+
+        $columns  = $this->get_columns();
+        $hidden   = array();
+        $sortable = $this->get_sortable_columns();
+
+        $this->_column_headers = array( $columns, $hidden, $sortable );
+
+        $this->set_pagination_args(
+            array(
+            'total_items' => $this->current_total_count,
+            'per_page'    => $this->per_page,
+            'total_pages' => ceil( $this->current_total_count / $this->per_page )
+            )
+        );
+    }
+
+    /**
+     * Table columns
+     *
+     * @return array
+     */
+    public function get_columns(){
+        $columns = array(
+            'cb'                => '<input type="checkbox" />',
+            'subscription'      => __( 'Subscription', 'invoicing' ),
+            'start_date'        => __( 'Start Date', 'invoicing' ),
+            'renewal_date'      => __( 'Next Payment', 'invoicing' ),
+            'renewals'          => __( 'Payments', 'invoicing' ),
+            'item'              => __( 'Items', 'invoicing' ),
+            'status'            => __( 'Status', 'invoicing' ),
+        );
+
+        return apply_filters( 'manage_getpaid_subscriptions_table_columns', $columns );
+    }
+
+    /**
+     * Sortable table columns.
+     *
+     * @return array
+     */
+    public function get_sortable_columns() {
+        $sortable = array(
+            'subscription' => array( 'id', true ),
+            'start_date'   => array( 'created', true ),
+            'renewal_date' => array( 'expiration', true ),
+            'renewals'     => array( 'bill_times', true ),
+            'item'         => array( 'product_id', true ),
+            'status'       => array( 'status', true ),
+        );
+
+        return apply_filters( 'manage_getpaid_subscriptions_sortable_table_columns', $sortable );
+    }
+
+    /**
+     * Whether the table has items to display or not
+     *
+     * @return bool
+     */
+    public function has_items() {
+        return ! empty( $this->current_total_count );
+    }
+
+    /**
+     * Processes bulk actions.
+     *
+     */
+    public function process_bulk_action() {
+
+    }
 
 }

Spacing +95 added lines, -95 removed lines

@@ -3,9 +3,9 @@ 
  * Displays a list of all subscriptions rules
  */
 
-if ( ! defined( 'ABSPATH' ) ) exit;
+if (!defined('ABSPATH')) exit;
 
-if ( ! class_exists( 'WP_List_Table' ) ) {
+if (!class_exists('WP_List_Table')) {
 	include_once ABSPATH . 'wp-admin/includes/class-wp-list-table.php';
 }
 
@@ -78,7 +78,7 @@ 
 
 		$this->prepare_query();
 
-		$this->base_url = remove_query_arg( 'status' );
+		$this->base_url = remove_query_arg('status');
 
 	}
 
@@ -91,13 +91,13 @@ 
 		$query = array(
 			'number'  => $this->per_page,
 			'paged'   => $this->get_paged(),
-			'status'  => ( isset( $_GET['status'] ) && array_key_exists( $_GET['status'], getpaid_get_subscription_statuses() ) ) ? sanitize_text_field( $_GET['status'] ) : 'all',
-			'orderby' => ( isset( $_GET['orderby'] ) ) ? sanitize_text_field( $_GET['orderby'] ) : 'id',
-			'order'   => ( isset( $_GET['order'] ) ) ? sanitize_text_field( $_GET['order'] ) : 'DESC',
+			'status'  => (isset($_GET['status']) && array_key_exists($_GET['status'], getpaid_get_subscription_statuses())) ? sanitize_text_field($_GET['status']) : 'all',
+			'orderby' => (isset($_GET['orderby'])) ? sanitize_text_field($_GET['orderby']) : 'id',
+			'order'   => (isset($_GET['order'])) ? sanitize_text_field($_GET['order']) : 'DESC',
 			'customer_in' => $this->get_user_in(),
 		);
 
-		if ( is_array( $query['customer_in'] ) && empty( $query['customer_in'] ) ) {
+		if (is_array($query['customer_in']) && empty($query['customer_in'])) {
 			$this->total_count         = 0;
 			$this->current_total_count = 0;
 			$this->items               = array();
@@ -106,15 +106,15 @@ 
 		}
 
 		// Prepare class properties.
-		$this->query               = new GetPaid_Subscriptions_Query( $query );
+		$this->query               = new GetPaid_Subscriptions_Query($query);
 		$this->total_count         = $this->query->get_total();
 		$this->current_total_count = $this->query->get_total();
 		$this->items               = $this->query->get_results();
-		$this->status_counts       = getpaid_get_subscription_status_counts( $query );
+		$this->status_counts       = getpaid_get_subscription_status_counts($query);
 
-		if ( 'all' != $query['status'] ) {
-			unset( $query['status'] );
-			$this->total_count   = getpaid_get_subscriptions( $query, 'count' );
+		if ('all' != $query['status']) {
+			unset($query['status']);
+			$this->total_count = getpaid_get_subscriptions($query, 'count');
 		}
 
 	}
@@ -126,14 +126,14 @@ 
 	public function get_user_in() {
 
 		// Abort if no user.
-		if ( empty( $_GET['s'] ) ) {
+		if (empty($_GET['s'])) {
 			return null;
 		}
 
 		// Or invalid user.
-		$user = wp_unslash( sanitize_text_field( $_REQUEST['s'] ) );
+		$user = wp_unslash(sanitize_text_field($_REQUEST['s']));
 
-		if ( empty( $user ) ) {
+		if (empty($user)) {
 			return null;
 		}
 
@@ -162,26 +162,26 @@ 
 	 */
 	public function get_views() {
 
-		$current  = isset( $_GET['status'] ) ? sanitize_text_field( $_GET['status'] ) : 'all';
+		$current  = isset($_GET['status']) ? sanitize_text_field($_GET['status']) : 'all';
 		$views    = array(
 
 			'all' => sprintf(
 				'<a href="%s" %s>%s&nbsp;<span class="count">(%d)</span></a>',
-				esc_url( add_query_arg( 'status', false, $this->base_url ) ),
+				esc_url(add_query_arg('status', false, $this->base_url)),
 				$current === 'all' ? ' class="current"' : '',
-				__('All','invoicing' ),
+				__('All', 'invoicing'),
 				$this->total_count
 			)
 
 		);
 
-		foreach ( array_filter( $this->status_counts ) as $status => $count ) {
+		foreach (array_filter($this->status_counts) as $status => $count) {
 
-			$views[ $status ] = sprintf(
+			$views[$status] = sprintf(
 				'<a href="%s" %s>%s&nbsp;<span class="count">(%d)</span></a>',
-				esc_url( add_query_arg( 'status', urlencode( $status ), $this->base_url ) ),
+				esc_url(add_query_arg('status', urlencode($status), $this->base_url)),
 				$current === $status ? ' class="current"' : '',
-				esc_html( getpaid_get_subscription_status_label( $status ) ),
+				esc_html(getpaid_get_subscription_status_label($status)),
 				$count
 			);
 
@@ -198,8 +198,8 @@ 
 	 * @since       1.0.0
 	 * @return      string
 	 */
-	public function column_default( $item, $column_name ) {
-		return apply_filters( "getpaid_subscriptions_table_column_$column_name", $item->$column_name );
+	public function column_default($item, $column_name) {
+		return apply_filters("getpaid_subscriptions_table_column_$column_name", $item->$column_name);
 	}
 
 	/**
@@ -208,8 +208,8 @@ 
 	 * @param WPInv_Subscription $item
 	 * @return string
 	 */
-	public function column_cb( $item ) {
-		return sprintf( '<input type="checkbox" name="id[]" value="%s" />', esc_html( $item->get_id() ) );
+	public function column_cb($item) {
+		return sprintf('<input type="checkbox" name="id[]" value="%s" />', esc_html($item->get_id()));
 	}
 
 	/**
@@ -219,7 +219,7 @@ 
 	 * @since       1.0.0
 	 * @return      string
 	 */
-	public function column_status( $item ) {
+	public function column_status($item) {
 		return $item->get_status_label_html();
 	}
 
@@ -230,44 +230,44 @@ 
 	 * @since       1.0.0
 	 * @return      string
 	 */
-	public function column_subscription( $item ) {
+	public function column_subscription($item) {
 
-		$username = __( '(Missing User)', 'invoicing' );
+		$username = __('(Missing User)', 'invoicing');
 
-		$user = get_userdata( $item->get_customer_id() );
-		if ( $user ) {
+		$user = get_userdata($item->get_customer_id());
+		if ($user) {
 
 			$username = sprintf(
 				'<a href="user-edit.php?user_id=%s">%s</a>',
-				absint( $user->ID ),
-				! empty( $user->display_name ) ? esc_html( $user->display_name ) : sanitize_email( $user->user_email )
+				absint($user->ID),
+				!empty($user->display_name) ? esc_html($user->display_name) : sanitize_email($user->user_email)
 			);
 
 		}
 
 		// translators: $1: is opening link, $2: is subscription id number, $3: is closing link tag, $4: is user's name
 		$column_content = sprintf(
-			_x( '%1$s#%2$s%3$s for %4$s', 'Subscription title on admin table. (e.g.: #211 for John Doe)', 'invoicing' ),
-			'<a href="' . esc_url( admin_url( 'admin.php?page=wpinv-subscriptions&id=' . absint( $item->get_id() ) ) ) . '">',
-			'<strong>' . esc_attr( $item->get_id() ) . '</strong>', '</a>',
+			_x('%1$s#%2$s%3$s for %4$s', 'Subscription title on admin table. (e.g.: #211 for John Doe)', 'invoicing'),
+			'<a href="' . esc_url(admin_url('admin.php?page=wpinv-subscriptions&id=' . absint($item->get_id()))) . '">',
+			'<strong>' . esc_attr($item->get_id()) . '</strong>', '</a>',
 			$username
 		);
 
 		$row_actions = array();
 
 		// View subscription.
-		$view_url    = esc_url( add_query_arg( 'id', $item->get_id(), admin_url( 'admin.php?page=wpinv-subscriptions' ) ));
-		$row_actions['view'] = '<a href="' . $view_url . '">' . __( 'View Subscription', 'invoicing' ) . '</a>';
+		$view_url    = esc_url(add_query_arg('id', $item->get_id(), admin_url('admin.php?page=wpinv-subscriptions')));
+		$row_actions['view'] = '<a href="' . $view_url . '">' . __('View Subscription', 'invoicing') . '</a>';
 
 		// View invoice.
-		$invoice = get_post( $item->get_parent_invoice_id() );
+		$invoice = get_post($item->get_parent_invoice_id());
 
-		if ( ! empty( $invoice ) ) {
-			$invoice_url            = get_edit_post_link( $invoice );
-			$row_actions['invoice'] = '<a href="' . $invoice_url . '">' . __( 'View Invoice', 'invoicing' ) . '</a>';
+		if (!empty($invoice)) {
+			$invoice_url            = get_edit_post_link($invoice);
+			$row_actions['invoice'] = '<a href="' . $invoice_url . '">' . __('View Invoice', 'invoicing') . '</a>';
 		}
 
-		$delete_url            = esc_url(
+		$delete_url = esc_url(
 			wp_nonce_url(
 				add_query_arg(
 					array(
@@ -279,11 +279,11 @@ 
 				'getpaid-nonce'
 			)
 		);
-		$row_actions['delete'] = '<a class="text-danger" href="' . $delete_url . '">' . __( 'Delete Subscription', 'invoicing' ) . '</a>';
+		$row_actions['delete'] = '<a class="text-danger" href="' . $delete_url . '">' . __('Delete Subscription', 'invoicing') . '</a>';
 
-		$row_actions = $this->row_actions( apply_filters( 'getpaid_subscription_table_row_actions', $row_actions, $item ) );
+		$row_actions = $this->row_actions(apply_filters('getpaid_subscription_table_row_actions', $row_actions, $item));
 
-		return "<strong>$column_content</strong>" . $this->column_amount( $item ) . $row_actions;
+		return "<strong>$column_content</strong>" . $this->column_amount($item) . $row_actions;
 	}
 
 	/**
@@ -293,8 +293,8 @@ 
 	 * @since       1.0.0
 	 * @return      string
 	 */
-	public function column_renewal_date( $item ) {
-		return getpaid_format_date_value( $item->get_expiration() );
+	public function column_renewal_date($item) {
+		return getpaid_format_date_value($item->get_expiration());
 	}
 
 	/**
@@ -304,27 +304,27 @@ 
 	 * @since       1.0.0
 	 * @return      string
 	 */
-	public function column_start_date( $item ) {
+	public function column_start_date($item) {
 
 		$gateway = $item->get_parent_invoice()->get_gateway_title();
 
-		if ( empty( $gateway ) ) {
-			return getpaid_format_date_value( $item->get_date_created() );
+		if (empty($gateway)) {
+			return getpaid_format_date_value($item->get_date_created());
 		}
 
-		$url = apply_filters( 'getpaid_remote_subscription_profile_url', '', $item );
-		if ( ! empty( $url ) ) {
+		$url = apply_filters('getpaid_remote_subscription_profile_url', '', $item);
+		if (!empty($url)) {
 
-			return getpaid_format_date_value( $item->get_date_created() ) . '<br>' . sprintf(
-				__( 'Via %s', 'invoicing' ),
-				'<strong><a href="' . esc_url( $url ) . '" target="_blank">' . esc_html( $item->get_parent_invoice()->get_gateway_title() ) . '</a></strong>'
+			return getpaid_format_date_value($item->get_date_created()) . '<br>' . sprintf(
+				__('Via %s', 'invoicing'),
+				'<strong><a href="' . esc_url($url) . '" target="_blank">' . esc_html($item->get_parent_invoice()->get_gateway_title()) . '</a></strong>'
 			);
 
 		}
 
-		return getpaid_format_date_value( $item->get_date_created() ) . '<br>' . sprintf(
-			__( 'Via %s', 'invoicing' ),
-			'<strong>' . esc_html( $item->get_parent_invoice()->get_gateway_title() ) . '</strong>'
+		return getpaid_format_date_value($item->get_date_created()) . '<br>' . sprintf(
+			__('Via %s', 'invoicing'),
+			'<strong>' . esc_html($item->get_parent_invoice()->get_gateway_title()) . '</strong>'
 		);
 
 	}
@@ -336,8 +336,8 @@ 
 	 * @since       1.0.19
 	 * @return      string
 	 */
-	public static function column_amount( $item ) {
-		$amount = getpaid_get_formatted_subscription_amount( $item );
+	public static function column_amount($item) {
+		$amount = getpaid_get_formatted_subscription_amount($item);
 		return "<span class='text-muted form-text mt-2 mb-2'>$amount</span>";
 	}
 
@@ -348,9 +348,9 @@ 
 	 * @since       1.0.0
 	 * @return      string
 	 */
-	public function column_renewals( $item ) {
+	public function column_renewals($item) {
 		$max_bills = $item->get_bill_times();
-		return $item->get_times_billed() . ' / ' . ( empty( $max_bills ) ? "&infin;" : $max_bills );
+		return $item->get_times_billed() . ' / ' . (empty($max_bills) ? "&infin;" : $max_bills);
 	}
 
 	/**
@@ -360,15 +360,15 @@ 
 	 * @since       1.0.0
 	 * @return      string
 	 */
-	public function column_item( $item ) {
-		$subscription_group = getpaid_get_invoice_subscription_group( $item->get_parent_invoice_id(), $item->get_id() );
+	public function column_item($item) {
+		$subscription_group = getpaid_get_invoice_subscription_group($item->get_parent_invoice_id(), $item->get_id());
 
-		if ( empty( $subscription_group ) ) {
-			return $this->generate_item_markup( $item->get_product_id() );
+		if (empty($subscription_group)) {
+			return $this->generate_item_markup($item->get_product_id());
 		}
 
-		$markup = array_map( array( $this, 'generate_item_markup' ), array_keys( $subscription_group['items'] ) );
-		return implode( ' | ', $markup );
+		$markup = array_map(array($this, 'generate_item_markup'), array_keys($subscription_group['items']));
+		return implode(' | ', $markup);
 
 	}
 
@@ -379,16 +379,16 @@ 
 	 * @since       1.0.0
 	 * @return      string
 	 */
-	public static function generate_item_markup( $item_id ) {
-		$item = get_post( $item_id );
+	public static function generate_item_markup($item_id) {
+		$item = get_post($item_id);
 
-		if ( ! empty( $item ) ) {
-			$link = get_edit_post_link( $item );
-			$link = esc_url( $link );
-			$name = esc_html( get_the_title( $item ) );
+		if (!empty($item)) {
+			$link = get_edit_post_link($item);
+			$link = esc_url($link);
+			$name = esc_html(get_the_title($item));
 			return wpinv_current_user_can_manage_invoicing() ? "<a href='$link'>$name</a>" : $name;
 		} else {
-			return sprintf( __( 'Item #%s', 'invoicing' ), $item_id );
+			return sprintf(__('Item #%s', 'invoicing'), $item_id);
 		}
 
 	}
@@ -399,7 +399,7 @@ 
 	 * @return      int
 	 */
 	public function get_paged() {
-		return isset( $_GET['paged'] ) ? absint( $_GET['paged'] ) : 1;
+		return isset($_GET['paged']) ? absint($_GET['paged']) : 1;
 	}
 
 	/**
@@ -412,13 +412,13 @@ 
 		$hidden   = array();
 		$sortable = $this->get_sortable_columns();
 
-		$this->_column_headers = array( $columns, $hidden, $sortable );
+		$this->_column_headers = array($columns, $hidden, $sortable);
 
 		$this->set_pagination_args(
 			array(
 			'total_items' => $this->current_total_count,
 			'per_page'    => $this->per_page,
-			'total_pages' => ceil( $this->current_total_count / $this->per_page )
+			'total_pages' => ceil($this->current_total_count / $this->per_page)
 			)
 		);
 	}
@@ -428,18 +428,18 @@ 
 	 *
 	 * @return array
 	 */
-	public function get_columns(){
+	public function get_columns() {
 		$columns = array(
 			'cb'                => '<input type="checkbox" />',
-			'subscription'      => __( 'Subscription', 'invoicing' ),
-			'start_date'        => __( 'Start Date', 'invoicing' ),
-			'renewal_date'      => __( 'Next Payment', 'invoicing' ),
-			'renewals'          => __( 'Payments', 'invoicing' ),
-			'item'              => __( 'Items', 'invoicing' ),
-			'status'            => __( 'Status', 'invoicing' ),
+			'subscription'      => __('Subscription', 'invoicing'),
+			'start_date'        => __('Start Date', 'invoicing'),
+			'renewal_date'      => __('Next Payment', 'invoicing'),
+			'renewals'          => __('Payments', 'invoicing'),
+			'item'              => __('Items', 'invoicing'),
+			'status'            => __('Status', 'invoicing'),
 		);
 
-		return apply_filters( 'manage_getpaid_subscriptions_table_columns', $columns );
+		return apply_filters('manage_getpaid_subscriptions_table_columns', $columns);
 	}
 
 	/**
@@ -449,15 +449,15 @@ 
 	 */
 	public function get_sortable_columns() {
 		$sortable = array(
-			'subscription' => array( 'id', true ),
-			'start_date'   => array( 'created', true ),
-			'renewal_date' => array( 'expiration', true ),
-			'renewals'     => array( 'bill_times', true ),
-			'item'         => array( 'product_id', true ),
-			'status'       => array( 'status', true ),
+			'subscription' => array('id', true),
+			'start_date'   => array('created', true),
+			'renewal_date' => array('expiration', true),
+			'renewals'     => array('bill_times', true),
+			'item'         => array('product_id', true),
+			'status'       => array('status', true),
 		);
 
-		return apply_filters( 'manage_getpaid_subscriptions_sortable_table_columns', $sortable );
+		return apply_filters('manage_getpaid_subscriptions_sortable_table_columns', $sortable);
 	}
 
 	/**
@@ -466,7 +466,7 @@ 
 	 * @return bool
 	 */
 	public function has_items() {
-		return ! empty( $this->current_total_count );
+		return !empty($this->current_total_count);
 	}
 
 	/**

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
 	|--------------------------------------------------------------------------

Spacing +44 added lines, -44 removed lines

@@ -3,7 +3,7 @@ 
  * GetPaid_Payment_Form_Data_Store class file.
  *
  */
-if ( ! defined( 'ABSPATH' ) ) {
+if (!defined('ABSPATH')) {
 	exit;
 }
 
@@ -56,37 +56,37 @@ 
 	 *
 	 * @param GetPaid_Payment_Form $form Form object.
 	 */
-	public function create( &$form ) {
-		$form->set_version( WPINV_VERSION );
-		$form->set_date_created( current_time('mysql') );
+	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_date'     => $form->get_date_created('edit'),
 					'post_type'     => 'wpi_payment_form',
-					'post_status'   => $this->get_post_status( $form ),
+					'post_status'   => $this->get_post_status($form),
 					'ping_status'   => 'closed',
-					'post_author'   => $form->get_author( 'edit' ),
-					'post_title'    => $form->get_name( 'edit' ),
+					'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 );
+		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 );
+			$this->clear_caches($form);
+			do_action('getpaid_create_payment_form', $form);
 			return true;
 		}
 
-		if ( is_wp_error( $id ) ) {
+		if (is_wp_error($id)) {
 			$form->last_error = $id->get_error_message();
 		}
 
@@ -99,14 +99,14 @@ 
 	 * @param GetPaid_Payment_Form $form Form object.
 	 *
 	 */
-	public function read( &$form ) {
+	public function read(&$form) {
 
 		$form->set_defaults();
-		$form_object = get_post( $form->get_id() );
+		$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 );
+		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;
 		}
 
@@ -120,10 +120,10 @@ 
 			)
 		);
 
-		$this->read_object_data( $form, $form_object );
+		$this->read_object_data($form, $form_object);
 		$form->read_meta_data();
-		$form->set_object_read( true );
-		do_action( 'getpaid_read_payment_form', $form );
+		$form->set_object_read(true);
+		do_action('getpaid_read_payment_form', $form);
 
 	}
 
@@ -132,27 +132,27 @@ 
 	 *
 	 * @param GetPaid_Payment_Form $form Form object.
 	 */
-	public function update( &$form ) {
+	public function update(&$form) {
 		$form->save_meta_data();
-		$form->set_version( WPINV_VERSION );
+		$form->set_version(WPINV_VERSION);
 
-		if ( null === $form->get_date_created( 'edit' ) ) {
-			$form->set_date_created(  current_time('mysql') );
+		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() );
+		$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 ) ) ) {
+		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' ),
+				'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'),
 			);
 
 			/**
@@ -163,25 +163,25 @@ 
 			 * 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() );
+			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 ) );
+				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.
+			$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 );
+		$this->update_post_meta($form);
 		$form->apply_changes();
-		$this->clear_caches( $form );
+		$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' );
+		$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 );
+		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 );
+			do_action('getpaid_update_payment_form', $form);
 		}
 
 	}

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

Spacing +46 added lines, -46 removed lines

@@ -4,7 +4,7 @@ 
  * GetPaid_Discount_Data_Store class file.
  *
  */
-if ( ! defined( 'ABSPATH' ) ) {
+if (!defined('ABSPATH')) {
 	exit;
 }
 
@@ -71,38 +71,38 @@ 
 	 *
 	 * @param WPInv_Discount $discount Discount object.
 	 */
-	public function create( &$discount ) {
-		$discount->set_version( WPINV_VERSION );
-		$discount->set_date_created( current_time('mysql') );
+	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_date'     => $discount->get_date_created('edit'),
 					'post_type'     => 'wpi_discount',
-					'post_status'   => $this->get_post_status( $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' ),
+					'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 );
+		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 );
+			$this->clear_caches($discount);
+			do_action('getpaid_new_discount', $discount);
 			return true;
 		}
 
-		if ( is_wp_error( $id ) ) {
+		if (is_wp_error($id)) {
 			$discount->last_error = $id->get_error_message();
 		}
 
@@ -115,14 +115,14 @@ 
 	 * @param WPInv_Discount $discount Discount object.
 	 *
 	 */
-	public function read( &$discount ) {
+	public function read(&$discount) {
 
 		$discount->set_defaults();
-		$discount_object = get_post( $discount->get_id() );
+		$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 );
+		if (!$discount->get_id() || !$discount_object || $discount_object->post_type != 'wpi_discount') {
+			$discount->last_error = __('Invalid discount.', 'invoicing');
+			$discount->set_id(0);
 			return false;
 		}
 
@@ -137,10 +137,10 @@ 
 			)
 		);
 
-		$this->read_object_data( $discount, $discount_object );
+		$this->read_object_data($discount, $discount_object);
 		$discount->read_meta_data();
-		$discount->set_object_read( true );
-		do_action( 'getpaid_read_discount', $discount );
+		$discount->set_object_read(true);
+		do_action('getpaid_read_discount', $discount);
 
 	}
 
@@ -149,28 +149,28 @@ 
 	 *
 	 * @param WPInv_Discount $discount Discount object.
 	 */
-	public function update( &$discount ) {
+	public function update(&$discount) {
 		$discount->save_meta_data();
-		$discount->set_version( WPINV_VERSION );
+		$discount->set_version(WPINV_VERSION);
 
-		if ( null === $discount->get_date_created( 'edit' ) ) {
-			$discount->set_date_created(  current_time('mysql') );
+		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() );
+		$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 ) ) ) {
+		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' ),
+				'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'),
 			);
 
 			/**
@@ -181,25 +181,25 @@ 
 			 * 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() );
+			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 ) );
+				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.
+			$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 );
+		$this->update_post_meta($discount);
 		$discount->apply_changes();
-		$this->clear_caches( $discount );
+		$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' );
+		$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 );
+		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 );
+			do_action('getpaid_update_discount', $discount);
 		}
 
 	}

Indentation +188 added lines, -188 removed lines

@@ -5,7 +5,7 @@ 
  *
  */
 if ( ! defined( 'ABSPATH' ) ) {
-	exit;
+    exit;
 }
 
 /**
@@ -15,198 +15,198 @@ 
  */
 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_required_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_required_items' => 'required_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_required_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_required_items' => 'required_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
 	|--------------------------------------------------------------------------

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

Indentation +338 added lines, -338 removed lines

@@ -14,346 +14,346 @@
  */
 class GetPaid_Data_Store_WP {
 
-	/**
-	 * Meta type. This should match up with
-	 * the types available at https://developer.wordpress.org/reference/functions/add_metadata/.
-	 * WP defines 'post', 'user', 'comment', and 'term'.
-	 *
-	 * @var string
-	 */
-	protected $meta_type = 'post';
-
-	/**
-	 * This only needs set if you are using a custom metadata type.
-	 *
-	 * @var string
-	 */
-	protected $object_id_field_for_meta = '';
-
-	/**
-	 * Data stored in meta keys, but not considered "meta" for an object.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @var array
-	 */
-	protected $internal_meta_keys = array();
-
-	/**
-	 * Meta data which should exist in the DB, even if empty.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @var array
-	 */
-	protected $must_exist_meta_keys = array();
-
-	/**
-	 * A map of meta keys to data props.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @var array
-	 */
-	protected $meta_key_to_props = array();
-
-	/**
-	 * Returns an array of meta for an object.
-	 *
-	 * @since  1.0.19
-	 * @param  GetPaid_Data $object GetPaid_Data object.
-	 * @return array
-	 */
-	public function read_meta( &$object ) {
-		global $wpdb;
-		$db_info       = $this->get_db_info();
-		$raw_meta_data = $wpdb->get_results(
-			$wpdb->prepare(
-				"SELECT {$db_info['meta_id_field']} as meta_id, meta_key, meta_value
+    /**
+     * Meta type. This should match up with
+     * the types available at https://developer.wordpress.org/reference/functions/add_metadata/.
+     * WP defines 'post', 'user', 'comment', and 'term'.
+     *
+     * @var string
+     */
+    protected $meta_type = 'post';
+
+    /**
+     * This only needs set if you are using a custom metadata type.
+     *
+     * @var string
+     */
+    protected $object_id_field_for_meta = '';
+
+    /**
+     * Data stored in meta keys, but not considered "meta" for an object.
+     *
+     * @since 1.0.19
+     *
+     * @var array
+     */
+    protected $internal_meta_keys = array();
+
+    /**
+     * Meta data which should exist in the DB, even if empty.
+     *
+     * @since 1.0.19
+     *
+     * @var array
+     */
+    protected $must_exist_meta_keys = array();
+
+    /**
+     * A map of meta keys to data props.
+     *
+     * @since 1.0.19
+     *
+     * @var array
+     */
+    protected $meta_key_to_props = array();
+
+    /**
+     * Returns an array of meta for an object.
+     *
+     * @since  1.0.19
+     * @param  GetPaid_Data $object GetPaid_Data object.
+     * @return array
+     */
+    public function read_meta( &$object ) {
+        global $wpdb;
+        $db_info       = $this->get_db_info();
+        $raw_meta_data = $wpdb->get_results(
+            $wpdb->prepare(
+                "SELECT {$db_info['meta_id_field']} as meta_id, meta_key, meta_value
 				FROM {$db_info['table']}
 				WHERE {$db_info['object_id_field']} = %d
 				ORDER BY {$db_info['meta_id_field']}",
-				$object->get_id()
-			)
-		);
-
-		$this->internal_meta_keys = array_merge( array_map( array( $this, 'prefix_key' ), $object->get_data_keys() ), $this->internal_meta_keys );
-		$meta_data                = array_filter( $raw_meta_data, array( $this, 'exclude_internal_meta_keys' ) );
-		return apply_filters( "getpaid_data_store_wp_{$this->meta_type}_read_meta", $meta_data, $object, $this );
-	}
-
-	/**
-	 * Deletes meta based on meta ID.
-	 *
-	 * @since  1.0.19
-	 * @param  GetPaid_Data  $object GetPaid_Data object.
-	 * @param  stdClass $meta (containing at least ->id).
-	 */
-	public function delete_meta( &$object, $meta ) {
-		delete_metadata_by_mid( $this->meta_type, $meta->id );
-	}
-
-	/**
-	 * Add new piece of meta.
-	 *
-	 * @since  1.0.19
-	 * @param  GetPaid_Data  $object GetPaid_Data object.
-	 * @param  stdClass $meta (containing ->key and ->value).
-	 * @return int meta ID
-	 */
-	public function add_meta( &$object, $meta ) {
-		return add_metadata( $this->meta_type, $object->get_id(), $meta->key, is_string( $meta->value ) ? wp_slash( $meta->value ) : $meta->value, false );
-	}
-
-	/**
-	 * Update meta.
-	 *
-	 * @since  1.0.19
-	 * @param  GetPaid_Data  $object GetPaid_Data object.
-	 * @param  stdClass $meta (containing ->id, ->key and ->value).
-	 */
-	public function update_meta( &$object, $meta ) {
-		update_metadata_by_mid( $this->meta_type, $meta->id, $meta->value, $meta->key );
-	}
-
-	/**
-	 * Table structure is slightly different between meta types, this function will return what we need to know.
-	 *
-	 * @since  1.0.19
-	 * @return array Array elements: table, object_id_field, meta_id_field
-	 */
-	protected function get_db_info() {
-		global $wpdb;
-
-		$meta_id_field = 'meta_id'; // users table calls this umeta_id so we need to track this as well.
-		$table         = $wpdb->prefix;
-
-		// If we are dealing with a type of metadata that is not a core type, the table should be prefixed.
-		if ( ! in_array( $this->meta_type, array( 'post', 'user', 'comment', 'term' ), true ) ) {
-			$table .= 'getpaid_';
-		}
-
-		$table          .= $this->meta_type . 'meta';
-		$object_id_field = $this->meta_type . '_id';
-
-		// Figure out our field names.
-		if ( 'user' === $this->meta_type ) {
-			$meta_id_field = 'umeta_id';
-			$table         = $wpdb->usermeta;
-		}
-
-		if ( ! empty( $this->object_id_field_for_meta ) ) {
-			$object_id_field = $this->object_id_field_for_meta;
-		}
-
-		return array(
-			'table'           => $table,
-			'object_id_field' => $object_id_field,
-			'meta_id_field'   => $meta_id_field,
-		);
-	}
-
-	/**
-	 * Internal meta keys we don't want exposed as part of meta_data. This is in
-	 * addition to all data props with _ prefix.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @param string $key Prefix to be added to meta keys.
-	 * @return string
-	 */
-	protected function prefix_key( $key ) {
-		return '_' === substr( $key, 0, 1 ) ? $key : '_' . $key;
-	}
-
-	/**
-	 * Callback to remove unwanted meta data.
-	 *
-	 * @param object $meta Meta object to check if it should be excluded or not.
-	 * @return bool
-	 */
-	protected function exclude_internal_meta_keys( $meta ) {
-		return ! in_array( $meta->meta_key, $this->internal_meta_keys, true ) && 0 !== stripos( $meta->meta_key, 'wp_' );
-	}
-
-	/**
-	 * Gets a list of props and meta keys that need updated based on change state
-	 * or if they are present in the database or not.
-	 *
-	 * @param  GetPaid_Data $object         The GetPaid_Data object.
-	 * @param  array   $meta_key_to_props   A mapping of meta keys => prop names.
-	 * @param  string  $meta_type           The internal WP meta type (post, user, etc).
-	 * @return array                        A mapping of meta keys => prop names, filtered by ones that should be updated.
-	 */
-	protected function get_props_to_update( $object, $meta_key_to_props, $meta_type = 'post' ) {
-		$props_to_update = array();
-		$changed_props   = $object->get_changes();
-
-		// Props should be updated if they are a part of the $changed array or don't exist yet.
-		foreach ( $meta_key_to_props as $meta_key => $prop ) {
-			if ( array_key_exists( $prop, $changed_props ) || ! metadata_exists( $meta_type, $object->get_id(), $meta_key ) ) {
-				$props_to_update[ $meta_key ] = $prop;
-			}
-		}
-
-		return $props_to_update;
-	}
-
-	/**
-	 * Read object data.
-	 *
-	 * @param GetPaid_Data $object GetPaid_Data object.
-	 * @param WP_Post   $post_object Post object.
-	 * @since 1.0.19
-	 */
-	protected function read_object_data( &$object, $post_object ) {
-		$id    = $object->get_id();
-		$props = array();
-
-		foreach ( $this->meta_key_to_props as $meta_key => $prop ) {
-			$props[ $prop ] = get_post_meta( $id, $meta_key, true );
-		}
-
-		// Set object properties.
-		$object->set_props( $props );
-
-		// Gets extra data associated with the object if needed.
-		foreach ( $object->get_extra_data_keys() as $key ) {
-			$function = 'set_' . $key;
-			if ( is_callable( array( $object, $function ) ) ) {
-				$object->{$function}( get_post_meta( $object->get_id(), $key, true ) );
-			}
-		}
-	}
-
-	/**
-	 * Helper method that updates all the post meta for an object based on it's settings in the GetPaid_Data class.
-	 *
-	 * @param GetPaid_Data $object GetPaid_Data object.
-	 * @since 1.0.19
-	 */
-	protected function update_post_meta( &$object ) {
-
-		$updated_props   = array();
-		$props_to_update = $this->get_props_to_update( $object, $this->meta_key_to_props );
-		$object_type     = $object->get_object_type();
-
-		foreach ( $props_to_update as $meta_key => $prop ) {
-			$value = $object->{"get_$prop"}( 'edit' );
-			$value = is_string( $value ) ? wp_slash( $value ) : $value;
-
-			$updated = $this->update_or_delete_post_meta( $object, $meta_key, $value );
-
-			if ( $updated ) {
-				$updated_props[] = $prop;
-			}
-		}
-
-		do_action( "getpaid_{$object_type}_object_updated_props", $object, $updated_props );
-	}
-
-	/**
-	 * Update meta data in, or delete it from, the database.
-	 *
-	 * Avoids storing meta when it's either an empty string or empty array or null.
-	 * Other empty values such as numeric 0 should still be stored.
-	 * Data-stores can force meta to exist using `must_exist_meta_keys`.
-	 *
-	 * Note: WordPress `get_metadata` function returns an empty string when meta data does not exist.
-	 *
-	 * @param GetPaid_Data $object The GetPaid_Data object.
-	 * @param string  $meta_key Meta key to update.
-	 * @param mixed   $meta_value Value to save.
-	 *
-	 * @since 1.0.19 Added to prevent empty meta being stored unless required.
-	 *
-	 * @return bool True if updated/deleted.
-	 */
-	protected function update_or_delete_post_meta( $object, $meta_key, $meta_value ) {
-		if ( in_array( $meta_value, array( array(), '', null ), true ) && ! in_array( $meta_key, $this->must_exist_meta_keys, true ) ) {
-			$updated = delete_post_meta( $object->get_id(), $meta_key );
-		} else {
-			$updated = update_post_meta( $object->get_id(), $meta_key, $meta_value );
-		}
-
-		return (bool) $updated;
-	}
-
-	/**
-	 * Return list of internal meta keys.
-	 *
-	 * @since 1.0.19
-	 * @return array
-	 */
-	public function get_internal_meta_keys() {
-		return $this->internal_meta_keys;
-	}
-
-	/**
-	 * Clear any caches.
-	 *
-	 * @param GetPaid_Data $object GetPaid_Data object.
-	 * @since 1.0.19
-	 */
-	protected function clear_caches( &$object ) {
-		clean_post_cache( $object->get_id() );
-	}
-
-	/**
-	 * Method to delete a data object from the database.
-	 *
-	 * @param GetPaid_Data $object GetPaid_Data object.
-	 * @param array    $args Array of args to pass to the delete method.
-	 *
-	 * @return void
-	 */
-	public function delete( &$object, $args = array() ) {
-		$id          = $object->get_id();
-		$object_type = $object->get_object_type();
-
-		if ( 'invoice' == $object_type ) {
-			$object_type = $object->get_type();
-		}
-
-		$args        = wp_parse_args(
-			$args,
-			array(
-				'force_delete' => false,
-			)
-		);
-
-		if ( ! $id ) {
-			return;
-		}
-
-		if ( $args['force_delete'] ) {
-			do_action( "getpaid_delete_$object_type", $object );
-			wp_delete_post( $id, true );
-			$object->set_id( 0 );
-		} else {
-			do_action( "getpaid_trash_$object_type", $object );
-			wp_trash_post( $id );
-			$object->set_status( 'trash' );
-		}
-	}
-
-	/**
-	 * Get the status to save to the post object.
-	 *
-	 *
-	 * @since 1.0.19
-	 * @param  GetPaid_Data $object GetPaid_Data object.
-	 * @return string
-	 */
-	protected function get_post_status( $object ) {
-		$object_status = $object->get_status( 'edit' );
-		$object_type   = $object->get_object_type();
-
-		if ( ! $object_status ) {
-			$object_status = apply_filters( "getpaid_default_{$object_type}_status", 'draft' );
-		}
-
-		return $object_status;
-	}
+                $object->get_id()
+            )
+        );
+
+        $this->internal_meta_keys = array_merge( array_map( array( $this, 'prefix_key' ), $object->get_data_keys() ), $this->internal_meta_keys );
+        $meta_data                = array_filter( $raw_meta_data, array( $this, 'exclude_internal_meta_keys' ) );
+        return apply_filters( "getpaid_data_store_wp_{$this->meta_type}_read_meta", $meta_data, $object, $this );
+    }
+
+    /**
+     * Deletes meta based on meta ID.
+     *
+     * @since  1.0.19
+     * @param  GetPaid_Data  $object GetPaid_Data object.
+     * @param  stdClass $meta (containing at least ->id).
+     */
+    public function delete_meta( &$object, $meta ) {
+        delete_metadata_by_mid( $this->meta_type, $meta->id );
+    }
+
+    /**
+     * Add new piece of meta.
+     *
+     * @since  1.0.19
+     * @param  GetPaid_Data  $object GetPaid_Data object.
+     * @param  stdClass $meta (containing ->key and ->value).
+     * @return int meta ID
+     */
+    public function add_meta( &$object, $meta ) {
+        return add_metadata( $this->meta_type, $object->get_id(), $meta->key, is_string( $meta->value ) ? wp_slash( $meta->value ) : $meta->value, false );
+    }
+
+    /**
+     * Update meta.
+     *
+     * @since  1.0.19
+     * @param  GetPaid_Data  $object GetPaid_Data object.
+     * @param  stdClass $meta (containing ->id, ->key and ->value).
+     */
+    public function update_meta( &$object, $meta ) {
+        update_metadata_by_mid( $this->meta_type, $meta->id, $meta->value, $meta->key );
+    }
+
+    /**
+     * Table structure is slightly different between meta types, this function will return what we need to know.
+     *
+     * @since  1.0.19
+     * @return array Array elements: table, object_id_field, meta_id_field
+     */
+    protected function get_db_info() {
+        global $wpdb;
+
+        $meta_id_field = 'meta_id'; // users table calls this umeta_id so we need to track this as well.
+        $table         = $wpdb->prefix;
+
+        // If we are dealing with a type of metadata that is not a core type, the table should be prefixed.
+        if ( ! in_array( $this->meta_type, array( 'post', 'user', 'comment', 'term' ), true ) ) {
+            $table .= 'getpaid_';
+        }
+
+        $table          .= $this->meta_type . 'meta';
+        $object_id_field = $this->meta_type . '_id';
+
+        // Figure out our field names.
+        if ( 'user' === $this->meta_type ) {
+            $meta_id_field = 'umeta_id';
+            $table         = $wpdb->usermeta;
+        }
+
+        if ( ! empty( $this->object_id_field_for_meta ) ) {
+            $object_id_field = $this->object_id_field_for_meta;
+        }
+
+        return array(
+            'table'           => $table,
+            'object_id_field' => $object_id_field,
+            'meta_id_field'   => $meta_id_field,
+        );
+    }
+
+    /**
+     * Internal meta keys we don't want exposed as part of meta_data. This is in
+     * addition to all data props with _ prefix.
+     *
+     * @since 1.0.19
+     *
+     * @param string $key Prefix to be added to meta keys.
+     * @return string
+     */
+    protected function prefix_key( $key ) {
+        return '_' === substr( $key, 0, 1 ) ? $key : '_' . $key;
+    }
+
+    /**
+     * Callback to remove unwanted meta data.
+     *
+     * @param object $meta Meta object to check if it should be excluded or not.
+     * @return bool
+     */
+    protected function exclude_internal_meta_keys( $meta ) {
+        return ! in_array( $meta->meta_key, $this->internal_meta_keys, true ) && 0 !== stripos( $meta->meta_key, 'wp_' );
+    }
+
+    /**
+     * Gets a list of props and meta keys that need updated based on change state
+     * or if they are present in the database or not.
+     *
+     * @param  GetPaid_Data $object         The GetPaid_Data object.
+     * @param  array   $meta_key_to_props   A mapping of meta keys => prop names.
+     * @param  string  $meta_type           The internal WP meta type (post, user, etc).
+     * @return array                        A mapping of meta keys => prop names, filtered by ones that should be updated.
+     */
+    protected function get_props_to_update( $object, $meta_key_to_props, $meta_type = 'post' ) {
+        $props_to_update = array();
+        $changed_props   = $object->get_changes();
+
+        // Props should be updated if they are a part of the $changed array or don't exist yet.
+        foreach ( $meta_key_to_props as $meta_key => $prop ) {
+            if ( array_key_exists( $prop, $changed_props ) || ! metadata_exists( $meta_type, $object->get_id(), $meta_key ) ) {
+                $props_to_update[ $meta_key ] = $prop;
+            }
+        }
+
+        return $props_to_update;
+    }
+
+    /**
+     * Read object data.
+     *
+     * @param GetPaid_Data $object GetPaid_Data object.
+     * @param WP_Post   $post_object Post object.
+     * @since 1.0.19
+     */
+    protected function read_object_data( &$object, $post_object ) {
+        $id    = $object->get_id();
+        $props = array();
+
+        foreach ( $this->meta_key_to_props as $meta_key => $prop ) {
+            $props[ $prop ] = get_post_meta( $id, $meta_key, true );
+        }
+
+        // Set object properties.
+        $object->set_props( $props );
+
+        // Gets extra data associated with the object if needed.
+        foreach ( $object->get_extra_data_keys() as $key ) {
+            $function = 'set_' . $key;
+            if ( is_callable( array( $object, $function ) ) ) {
+                $object->{$function}( get_post_meta( $object->get_id(), $key, true ) );
+            }
+        }
+    }
+
+    /**
+     * Helper method that updates all the post meta for an object based on it's settings in the GetPaid_Data class.
+     *
+     * @param GetPaid_Data $object GetPaid_Data object.
+     * @since 1.0.19
+     */
+    protected function update_post_meta( &$object ) {
+
+        $updated_props   = array();
+        $props_to_update = $this->get_props_to_update( $object, $this->meta_key_to_props );
+        $object_type     = $object->get_object_type();
+
+        foreach ( $props_to_update as $meta_key => $prop ) {
+            $value = $object->{"get_$prop"}( 'edit' );
+            $value = is_string( $value ) ? wp_slash( $value ) : $value;
+
+            $updated = $this->update_or_delete_post_meta( $object, $meta_key, $value );
+
+            if ( $updated ) {
+                $updated_props[] = $prop;
+            }
+        }
+
+        do_action( "getpaid_{$object_type}_object_updated_props", $object, $updated_props );
+    }
+
+    /**
+     * Update meta data in, or delete it from, the database.
+     *
+     * Avoids storing meta when it's either an empty string or empty array or null.
+     * Other empty values such as numeric 0 should still be stored.
+     * Data-stores can force meta to exist using `must_exist_meta_keys`.
+     *
+     * Note: WordPress `get_metadata` function returns an empty string when meta data does not exist.
+     *
+     * @param GetPaid_Data $object The GetPaid_Data object.
+     * @param string  $meta_key Meta key to update.
+     * @param mixed   $meta_value Value to save.
+     *
+     * @since 1.0.19 Added to prevent empty meta being stored unless required.
+     *
+     * @return bool True if updated/deleted.
+     */
+    protected function update_or_delete_post_meta( $object, $meta_key, $meta_value ) {
+        if ( in_array( $meta_value, array( array(), '', null ), true ) && ! in_array( $meta_key, $this->must_exist_meta_keys, true ) ) {
+            $updated = delete_post_meta( $object->get_id(), $meta_key );
+        } else {
+            $updated = update_post_meta( $object->get_id(), $meta_key, $meta_value );
+        }
+
+        return (bool) $updated;
+    }
+
+    /**
+     * Return list of internal meta keys.
+     *
+     * @since 1.0.19
+     * @return array
+     */
+    public function get_internal_meta_keys() {
+        return $this->internal_meta_keys;
+    }
+
+    /**
+     * Clear any caches.
+     *
+     * @param GetPaid_Data $object GetPaid_Data object.
+     * @since 1.0.19
+     */
+    protected function clear_caches( &$object ) {
+        clean_post_cache( $object->get_id() );
+    }
+
+    /**
+     * Method to delete a data object from the database.
+     *
+     * @param GetPaid_Data $object GetPaid_Data object.
+     * @param array    $args Array of args to pass to the delete method.
+     *
+     * @return void
+     */
+    public function delete( &$object, $args = array() ) {
+        $id          = $object->get_id();
+        $object_type = $object->get_object_type();
+
+        if ( 'invoice' == $object_type ) {
+            $object_type = $object->get_type();
+        }
+
+        $args        = wp_parse_args(
+            $args,
+            array(
+                'force_delete' => false,
+            )
+        );
+
+        if ( ! $id ) {
+            return;
+        }
+
+        if ( $args['force_delete'] ) {
+            do_action( "getpaid_delete_$object_type", $object );
+            wp_delete_post( $id, true );
+            $object->set_id( 0 );
+        } else {
+            do_action( "getpaid_trash_$object_type", $object );
+            wp_trash_post( $id );
+            $object->set_status( 'trash' );
+        }
+    }
+
+    /**
+     * Get the status to save to the post object.
+     *
+     *
+     * @since 1.0.19
+     * @param  GetPaid_Data $object GetPaid_Data object.
+     * @return string
+     */
+    protected function get_post_status( $object ) {
+        $object_status = $object->get_status( 'edit' );
+        $object_type   = $object->get_object_type();
+
+        if ( ! $object_status ) {
+            $object_status = apply_filters( "getpaid_default_{$object_type}_status", 'draft' );
+        }
+
+        return $object_status;
+    }
 
 }

Spacing +58 added lines, -58 removed lines

@@ -5,7 +5,7 @@ 
  * @version 1.0.19
  */
 
-defined( 'ABSPATH' ) || exit;
+defined('ABSPATH') || exit;
 
 /**
  * GetPaid_Data_Store_WP class.
@@ -64,7 +64,7 @@ 
 	 * @param  GetPaid_Data $object GetPaid_Data object.
 	 * @return array
 	 */
-	public function read_meta( &$object ) {
+	public function read_meta(&$object) {
 		global $wpdb;
 		$db_info       = $this->get_db_info();
 		$raw_meta_data = $wpdb->get_results(
@@ -77,9 +77,9 @@ 
 			)
 		);
 
-		$this->internal_meta_keys = array_merge( array_map( array( $this, 'prefix_key' ), $object->get_data_keys() ), $this->internal_meta_keys );
-		$meta_data                = array_filter( $raw_meta_data, array( $this, 'exclude_internal_meta_keys' ) );
-		return apply_filters( "getpaid_data_store_wp_{$this->meta_type}_read_meta", $meta_data, $object, $this );
+		$this->internal_meta_keys = array_merge(array_map(array($this, 'prefix_key'), $object->get_data_keys()), $this->internal_meta_keys);
+		$meta_data                = array_filter($raw_meta_data, array($this, 'exclude_internal_meta_keys'));
+		return apply_filters("getpaid_data_store_wp_{$this->meta_type}_read_meta", $meta_data, $object, $this);
 	}
 
 	/**
@@ -89,8 +89,8 @@ 
 	 * @param  GetPaid_Data  $object GetPaid_Data object.
 	 * @param  stdClass $meta (containing at least ->id).
 	 */
-	public function delete_meta( &$object, $meta ) {
-		delete_metadata_by_mid( $this->meta_type, $meta->id );
+	public function delete_meta(&$object, $meta) {
+		delete_metadata_by_mid($this->meta_type, $meta->id);
 	}
 
 	/**
@@ -101,8 +101,8 @@ 
 	 * @param  stdClass $meta (containing ->key and ->value).
 	 * @return int meta ID
 	 */
-	public function add_meta( &$object, $meta ) {
-		return add_metadata( $this->meta_type, $object->get_id(), $meta->key, is_string( $meta->value ) ? wp_slash( $meta->value ) : $meta->value, false );
+	public function add_meta(&$object, $meta) {
+		return add_metadata($this->meta_type, $object->get_id(), $meta->key, is_string($meta->value) ? wp_slash($meta->value) : $meta->value, false);
 	}
 
 	/**
@@ -112,8 +112,8 @@ 
 	 * @param  GetPaid_Data  $object GetPaid_Data object.
 	 * @param  stdClass $meta (containing ->id, ->key and ->value).
 	 */
-	public function update_meta( &$object, $meta ) {
-		update_metadata_by_mid( $this->meta_type, $meta->id, $meta->value, $meta->key );
+	public function update_meta(&$object, $meta) {
+		update_metadata_by_mid($this->meta_type, $meta->id, $meta->value, $meta->key);
 	}
 
 	/**
@@ -129,7 +129,7 @@ 
 		$table         = $wpdb->prefix;
 
 		// If we are dealing with a type of metadata that is not a core type, the table should be prefixed.
-		if ( ! in_array( $this->meta_type, array( 'post', 'user', 'comment', 'term' ), true ) ) {
+		if (!in_array($this->meta_type, array('post', 'user', 'comment', 'term'), true)) {
 			$table .= 'getpaid_';
 		}
 
@@ -137,12 +137,12 @@ 
 		$object_id_field = $this->meta_type . '_id';
 
 		// Figure out our field names.
-		if ( 'user' === $this->meta_type ) {
+		if ('user' === $this->meta_type) {
 			$meta_id_field = 'umeta_id';
 			$table         = $wpdb->usermeta;
 		}
 
-		if ( ! empty( $this->object_id_field_for_meta ) ) {
+		if (!empty($this->object_id_field_for_meta)) {
 			$object_id_field = $this->object_id_field_for_meta;
 		}
 
@@ -162,8 +162,8 @@ 
 	 * @param string $key Prefix to be added to meta keys.
 	 * @return string
 	 */
-	protected function prefix_key( $key ) {
-		return '_' === substr( $key, 0, 1 ) ? $key : '_' . $key;
+	protected function prefix_key($key) {
+		return '_' === substr($key, 0, 1) ? $key : '_' . $key;
 	}
 
 	/**
@@ -172,8 +172,8 @@ 
 	 * @param object $meta Meta object to check if it should be excluded or not.
 	 * @return bool
 	 */
-	protected function exclude_internal_meta_keys( $meta ) {
-		return ! in_array( $meta->meta_key, $this->internal_meta_keys, true ) && 0 !== stripos( $meta->meta_key, 'wp_' );
+	protected function exclude_internal_meta_keys($meta) {
+		return !in_array($meta->meta_key, $this->internal_meta_keys, true) && 0 !== stripos($meta->meta_key, 'wp_');
 	}
 
 	/**
@@ -185,14 +185,14 @@ 
 	 * @param  string  $meta_type           The internal WP meta type (post, user, etc).
 	 * @return array                        A mapping of meta keys => prop names, filtered by ones that should be updated.
 	 */
-	protected function get_props_to_update( $object, $meta_key_to_props, $meta_type = 'post' ) {
+	protected function get_props_to_update($object, $meta_key_to_props, $meta_type = 'post') {
 		$props_to_update = array();
 		$changed_props   = $object->get_changes();
 
 		// Props should be updated if they are a part of the $changed array or don't exist yet.
-		foreach ( $meta_key_to_props as $meta_key => $prop ) {
-			if ( array_key_exists( $prop, $changed_props ) || ! metadata_exists( $meta_type, $object->get_id(), $meta_key ) ) {
-				$props_to_update[ $meta_key ] = $prop;
+		foreach ($meta_key_to_props as $meta_key => $prop) {
+			if (array_key_exists($prop, $changed_props) || !metadata_exists($meta_type, $object->get_id(), $meta_key)) {
+				$props_to_update[$meta_key] = $prop;
 			}
 		}
 
@@ -206,22 +206,22 @@ 
 	 * @param WP_Post   $post_object Post object.
 	 * @since 1.0.19
 	 */
-	protected function read_object_data( &$object, $post_object ) {
+	protected function read_object_data(&$object, $post_object) {
 		$id    = $object->get_id();
 		$props = array();
 
-		foreach ( $this->meta_key_to_props as $meta_key => $prop ) {
-			$props[ $prop ] = get_post_meta( $id, $meta_key, true );
+		foreach ($this->meta_key_to_props as $meta_key => $prop) {
+			$props[$prop] = get_post_meta($id, $meta_key, true);
 		}
 
 		// Set object properties.
-		$object->set_props( $props );
+		$object->set_props($props);
 
 		// Gets extra data associated with the object if needed.
-		foreach ( $object->get_extra_data_keys() as $key ) {
+		foreach ($object->get_extra_data_keys() as $key) {
 			$function = 'set_' . $key;
-			if ( is_callable( array( $object, $function ) ) ) {
-				$object->{$function}( get_post_meta( $object->get_id(), $key, true ) );
+			if (is_callable(array($object, $function))) {
+				$object->{$function}(get_post_meta($object->get_id(), $key, true));
 			}
 		}
 	}
@@ -232,24 +232,24 @@ 
 	 * @param GetPaid_Data $object GetPaid_Data object.
 	 * @since 1.0.19
 	 */
-	protected function update_post_meta( &$object ) {
+	protected function update_post_meta(&$object) {
 
 		$updated_props   = array();
-		$props_to_update = $this->get_props_to_update( $object, $this->meta_key_to_props );
+		$props_to_update = $this->get_props_to_update($object, $this->meta_key_to_props);
 		$object_type     = $object->get_object_type();
 
-		foreach ( $props_to_update as $meta_key => $prop ) {
-			$value = $object->{"get_$prop"}( 'edit' );
-			$value = is_string( $value ) ? wp_slash( $value ) : $value;
+		foreach ($props_to_update as $meta_key => $prop) {
+			$value = $object->{"get_$prop"}('edit');
+			$value = is_string($value) ? wp_slash($value) : $value;
 
-			$updated = $this->update_or_delete_post_meta( $object, $meta_key, $value );
+			$updated = $this->update_or_delete_post_meta($object, $meta_key, $value);
 
-			if ( $updated ) {
+			if ($updated) {
 				$updated_props[] = $prop;
 			}
 		}
 
-		do_action( "getpaid_{$object_type}_object_updated_props", $object, $updated_props );
+		do_action("getpaid_{$object_type}_object_updated_props", $object, $updated_props);
 	}
 
 	/**
@@ -269,11 +269,11 @@ 
 	 *
 	 * @return bool True if updated/deleted.
 	 */
-	protected function update_or_delete_post_meta( $object, $meta_key, $meta_value ) {
-		if ( in_array( $meta_value, array( array(), '', null ), true ) && ! in_array( $meta_key, $this->must_exist_meta_keys, true ) ) {
-			$updated = delete_post_meta( $object->get_id(), $meta_key );
+	protected function update_or_delete_post_meta($object, $meta_key, $meta_value) {
+		if (in_array($meta_value, array(array(), '', null), true) && !in_array($meta_key, $this->must_exist_meta_keys, true)) {
+			$updated = delete_post_meta($object->get_id(), $meta_key);
 		} else {
-			$updated = update_post_meta( $object->get_id(), $meta_key, $meta_value );
+			$updated = update_post_meta($object->get_id(), $meta_key, $meta_value);
 		}
 
 		return (bool) $updated;
@@ -295,8 +295,8 @@ 
 	 * @param GetPaid_Data $object GetPaid_Data object.
 	 * @since 1.0.19
 	 */
-	protected function clear_caches( &$object ) {
-		clean_post_cache( $object->get_id() );
+	protected function clear_caches(&$object) {
+		clean_post_cache($object->get_id());
 	}
 
 	/**
@@ -307,33 +307,33 @@ 
 	 *
 	 * @return void
 	 */
-	public function delete( &$object, $args = array() ) {
+	public function delete(&$object, $args = array()) {
 		$id          = $object->get_id();
 		$object_type = $object->get_object_type();
 
-		if ( 'invoice' == $object_type ) {
+		if ('invoice' == $object_type) {
 			$object_type = $object->get_type();
 		}
 
-		$args        = wp_parse_args(
+		$args = wp_parse_args(
 			$args,
 			array(
 				'force_delete' => false,
 			)
 		);
 
-		if ( ! $id ) {
+		if (!$id) {
 			return;
 		}
 
-		if ( $args['force_delete'] ) {
-			do_action( "getpaid_delete_$object_type", $object );
-			wp_delete_post( $id, true );
-			$object->set_id( 0 );
+		if ($args['force_delete']) {
+			do_action("getpaid_delete_$object_type", $object);
+			wp_delete_post($id, true);
+			$object->set_id(0);
 		} else {
-			do_action( "getpaid_trash_$object_type", $object );
-			wp_trash_post( $id );
-			$object->set_status( 'trash' );
+			do_action("getpaid_trash_$object_type", $object);
+			wp_trash_post($id);
+			$object->set_status('trash');
 		}
 	}
 
@@ -345,12 +345,12 @@ 
 	 * @param  GetPaid_Data $object GetPaid_Data object.
 	 * @return string
 	 */
-	protected function get_post_status( $object ) {
-		$object_status = $object->get_status( 'edit' );
+	protected function get_post_status($object) {
+		$object_status = $object->get_status('edit');
 		$object_type   = $object->get_object_type();
 
-		if ( ! $object_status ) {
-			$object_status = apply_filters( "getpaid_default_{$object_type}_status", 'draft' );
+		if (!$object_status) {
+			$object_status = apply_filters("getpaid_default_{$object_type}_status", 'draft');
 		}
 
 		return $object_status;

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

Indentation +471 added lines, -471 removed lines

@@ -17,476 +17,476 @@
  */
 class GetPaid_REST_CRUD_Controller extends GetPaid_REST_Controller {
 
-	/**
-	 * Contains this controller's class name.
-	 *
-	 * @var string
-	 */
-	public $crud_class;
-
-	/**
-	 * Contains the current CRUD object.
-	 *
-	 * @var GetPaid_Data
-	 */
-	protected $data_object;
-
-	/**
-	 * Registers the routes for the objects of the controller.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @see register_rest_route()
-	 */
-	public function register_namespace_routes( $namespace ) {
-
-		register_rest_route(
-			$namespace,
-			'/' . $this->rest_base,
-			array(
-				array(
-					'methods'             => WP_REST_Server::READABLE,
-					'callback'            => array( $this, 'get_items' ),
-					'permission_callback' => array( $this, 'get_items_permissions_check' ),
-					'args'                => $this->get_collection_params(),
-				),
-				array(
-					'methods'             => WP_REST_Server::CREATABLE,
-					'callback'            => array( $this, 'create_item' ),
-					'permission_callback' => array( $this, 'create_item_permissions_check' ),
-					'args'                => $this->get_endpoint_args_for_item_schema( WP_REST_Server::CREATABLE ),
-				),
-				'schema' => array( $this, 'get_public_item_schema' ),
-			)
-		);
-
-		$get_item_args = array(
-			'context' => $this->get_context_param( array( 'default' => 'view' ) ),
-		);
-
-		register_rest_route(
-			$namespace,
-			'/' . $this->rest_base . '/(?P<id>[\d]+)',
-			array(
-				'args'   => array(
-					'id' => array(
-						'description' => __( 'Unique identifier for the object.', 'invoicing' ),
-						'type'        => 'integer',
-					),
-				),
-				array(
-					'methods'             => WP_REST_Server::READABLE,
-					'callback'            => array( $this, 'get_item' ),
-					'permission_callback' => array( $this, 'get_item_permissions_check' ),
-					'args'                => $get_item_args,
-				),
-				array(
-					'methods'             => WP_REST_Server::EDITABLE,
-					'callback'            => array( $this, 'update_item' ),
-					'permission_callback' => array( $this, 'update_item_permissions_check' ),
-					'args'                => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ),
-				),
-				array(
-					'methods'             => WP_REST_Server::DELETABLE,
-					'callback'            => array( $this, 'delete_item' ),
-					'permission_callback' => array( $this, 'delete_item_permissions_check' ),
-					'args'                => array(
-						'force' => array(
-							'type'        => 'boolean',
-							'default'     => false,
-							'description' => __( 'Whether to bypass Trash and force deletion.', 'invoicing' ),
-						),
-					),
-				),
-				'schema' => array( $this, 'get_public_item_schema' ),
-			)
-		);
-
-	}
-
-	/**
-	 * Saves a single object.
-	 *
-	 * @param GetPaid_Data $object Object to save.
-	 * @return WP_Error|GetPaid_Data
-	 */
-	protected function save_object( $object ) {
-		$object->save();
-
-		if ( ! empty( $object->last_error ) ) {
-			return new WP_Error( 'rest_cannot_save', $object->last_error, array( 'status' => 400 ) );
-		}
-
-		return new $this->crud_class( $object->get_id() );
-	}
-
-	/**
-	 * Retrieves a single object.
-	 *
-	 * @since 1.0.13
-	 *
-	 * @param int|WP_Post $object_id Supplied ID.
-	 * @return GetPaid_Data|WP_Error GetPaid_Data object if ID is valid, WP_Error otherwise.
-	 */
-	protected function get_object( $object_id ) {
-
-		// Do we have an object?
-		if ( empty( $this->crud_class ) || ! class_exists( $this->crud_class ) ) {
-			return new WP_Error( 'no_crud_class', __( 'You need to specify a CRUD class for this controller', 'invoicing' ) );
-		}
-
-		// Fetch the object.
-		$object = new $this->crud_class( $object_id );
-		if ( ! empty( $object->last_error ) ) {
-			return new WP_Error( 'rest_object_invalid_id', $object->last_error, array( 'status' => 404 ) );
-		}
-
-		$this->data_object = $object;
-		return $object->get_id() ? $object : new WP_Error( 'rest_object_invalid_id', __( 'Invalid ID.', 'invoicing' ), array( 'status' => 404 ) );
-
-	}
-
-	/**
-	 * 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 the item.
-		$object = $this->get_object( $request['id'] );
-
-		if ( is_wp_error( $object ) ) {
-			return $object;
-		}
-
-		// Generate a response.
-		return rest_ensure_response( $this->prepare_item_for_response( $object, $request ) );
-
-	}
-
-	/**
-	 * 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 ) {
-
-		// Can not create an existing item.
-		if ( ! empty( $request['id'] ) ) {
-			/* translators: %s: post type */
-			return new WP_Error( "getpaid_rest_{$this->rest_base}_exists", __( 'Cannot create existing resource.', 'invoicing' ), array( 'status' => 400 ) );
-		}
-
-		// Generate a GetPaid_Data object from the request.
-		$object = $this->prepare_item_for_database( $request );
-		if ( is_wp_error( $object ) ) {
-			return $object;
-		}
-
-		// Save the object.
-		$object = $this->save_object( $object );
-		if ( is_wp_error( $object ) ) {
-			return $object;
-		}
-
-		// Save special fields.
-		$save_special = $this->update_additional_fields_for_object( $object, $request );
-		if ( is_wp_error( $save_special ) ) {
-			$object->delete( true );
-			return $save_special;
-		}
-
-		$request->set_param( 'context', 'edit' );
-		$response = $this->prepare_item_for_response( $object, $request );
-		$response = rest_ensure_response( $response );
-		$response->set_status( 201 );
-		$response->header( 'Location', rest_url( sprintf( '/%s/%s/%d', $this->namespace, $this->rest_base, $object->get_id() ) ) );
-
-		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 ) {
-
-		// Fetch the item.
-		$object = $this->get_object( $request['id'] );
-		if ( is_wp_error( $object ) ) {
-			return $object;
-		}
-
-		// Prepare the item for saving.
-		$object = $this->prepare_item_for_database( $request );
-		if ( is_wp_error( $object ) ) {
-			return $object;
-		}
-
-		// Save the item.
-		$object = $this->save_object( $object );
-		if ( is_wp_error( $object ) ) {
-			return $object;
-		}
-
-		// Save special fields (those added via hooks).
-		$save_special = $this->update_additional_fields_for_object( $object, $request );
-		if ( is_wp_error( $save_special ) ) {
-			return $save_special;
-		}
-
-		$request->set_param( 'context', 'edit' );
-		$response = $this->prepare_item_for_response( $object, $request );
-		return rest_ensure_response( $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 = array(
-			'self'       => array(
-				'href'   => rest_url( sprintf( '/%s/%s/%d', $this->namespace, $this->rest_base, $object->get_id() ) ),
-			),
-			'collection' => array(
-				'href'   => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ),
-			),
-		);
-
-		return $links;
-	}
-
-	/**
-	 * Get the query params for collections of attachments.
-	 *
-	 * @return array
-	 */
-	public function get_collection_params() {
-		$params = parent::get_collection_params();
-		$params['context']['default'] = 'view';
-		return $params;
-	}
-
-	/**
-	 * Only return writable props from schema.
-	 *
-	 * @param  array $schema Schema.
-	 * @return bool
-	 */
-	public function filter_writable_props( $schema ) {
-		return empty( $schema['readonly'] );
-	}
-
-	/**
-	 * Prepare a single object for create or update.
-	 *
-	 * @since 1.0.19
-	 * @param  WP_REST_Request $request Request object.
-	 * @return GetPaid_Data|WP_Error Data object or WP_Error.
-	 */
-	protected function prepare_item_for_database( $request ) {
-
-		// Do we have an object?
-		if ( empty( $this->crud_class ) || ! class_exists( $this->crud_class ) ) {
-			return new WP_Error( 'no_crud_class', __( 'You need to specify a CRUD class for this controller', 'invoicing' ) );
-		}
-
-		// Prepare the object.
-		$id        = isset( $request['id'] ) ? absint( $request['id'] ) : 0;
-		$object    = new $this->crud_class( $id );
-
-		// Abort if an error exists.
-		if ( ! empty( $object->last_error ) ) {
-			return new WP_Error( 'invalid_item', $object->last_error );
-		}
-
-		$schema    = $this->get_item_schema();
-		$data_keys = array_keys( array_filter( $schema['properties'], array( $this, 'filter_writable_props' ) ) );
-
-		// Handle all writable props.
-		foreach ( $data_keys as $key ) {
-			$value = $request[ $key ];
-
-			if ( ! is_null( $value ) ) {
-				switch ( $key ) {
-
-					case 'meta_data':
-						if ( is_array( $value ) ) {
-							foreach ( $value as $meta ) {
-								$object->update_meta_data( $meta['key'], $meta['value'], isset( $meta['id'] ) ? $meta['id'] : '' );
-							}
-						}
-						break;
-
-					default:
-						if ( is_callable( array( $object, "set_{$key}" ) ) ) {
-							$object->{"set_{$key}"}( $value );
-						}
-						break;
-				}
-			}
-
-		}
-
-		// Filters an object before it is inserted via the REST API..
-		return apply_filters( "getpaid_rest_pre_insert_{$this->rest_base}_object", $object, $request );
-	}
-
-	/**
-	 * Retrieves data from a GetPaid class.
-	 *
-	 * @since  1.0.19
-	 * @param  GetPaid_Meta_Data[]    $meta_data  meta data objects.
-	 * @return array
-	 */
-	protected function prepare_object_meta_data( $meta_data ) {
-		$meta = array();
-
-		foreach( $meta_data as $object ) {
-			$meta[] = $object->get_data();
-		}
-
-		return $meta;
-	}
-
-	/**
-	 * Retrieves invoice items.
-	 *
-	 * @since  1.0.19
-	 * @param  WPInv_Invoice $invoice  Invoice items.
-	 * @param array            $fields Fields to include.
-	 * @return array
-	 */
-	protected function prepare_invoice_items( $invoice ) {
-		$items = array();
-
-		foreach( $invoice->get_items() as $item ) {
-
-			$item_data = $item->prepare_data_for_saving();
-
-			if ( 'amount' == $invoice->get_template() ) {
-				$item_data['quantity'] = 1;
-			}
-
-			$items[] = $item_data;
-		}
-
-		return $items;
-	}
-
-	/**
-	 * Retrieves data from a GetPaid class.
-	 *
-	 * @since  1.0.19
-	 * @param  GetPaid_Data    $object  Data object.
-	 * @param array            $fields Fields to include.
-	 * @param string           $context either view or edit.
-	 * @return array
-	 */
-	protected function prepare_object_data( $object, $fields, $context = 'view' ) {
-
-		$data = array();
-
-		// Handle all writable props.
-		foreach ( array_keys( $this->get_schema_properties() ) as $key ) {
-
-			// Abort if it is not included.
-			if ( ! empty( $fields ) && ! $this->is_field_included( $key, $fields ) ) {
-				continue;
-			}
-
-			// Or this current object does not support the field.
-			if ( ! $this->object_supports_field( $object, $key ) ) {
-				continue;
-			}
-
-			// Handle meta data.
-			if ( $key == 'meta_data' ) {
-				$data['meta_data'] = $this->prepare_object_meta_data( $object->get_meta_data() );
-				continue;
-			}
-
-			// Handle items.
-			if ( $key == 'items' && is_a( $object, 'WPInv_Invoice' )  ) {
-				$data['items'] = $this->prepare_invoice_items( $object );
-				continue;
-			}
-
-			// Booleans.
-			if ( is_callable( array( $object, $key ) ) ) {
-				$data[ $key ] = $object->$key( $context );
-				continue;
-			}
-
-			// Get object value.
-			if ( is_callable( array( $object, "get_{$key}" ) ) ) {
-				$value = $object->{"get_{$key}"}( $context );
-
-				// If the value is an instance of GetPaid_Data...
-				if ( is_a( $value, 'GetPaid_Data' ) ) {
-					$value = $value->get_data( $context );
-				}
-
-				// For objects, retrieves it's properties.
-				$data[ $key ] = is_object( $value ) ? get_object_vars( $value ) :  $value ;
-				continue;
-			}
-
-		}
-
-		return $data;
-	}
-
-	/**
-	 * 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 ) {
-		return apply_filters( 'getpaid_rest_object_supports_key', true, $object, $field_key );
-	}
-
-	/**
-	 * Prepare a single object output for response.
-	 *
-	 * @since  1.0.19
-	 * @param  GetPaid_Data    $object  Data object.
-	 * @param  WP_REST_Request $request Request object.
-	 * @return WP_REST_Response
-	 */
-	public function prepare_item_for_response( $object, $request ) {
-		remove_filter( 'rest_post_dispatch', 'rest_filter_response_fields', 10 );
-
-		$this->data_object = $object;
-
-		// Fetch the fields to include in this response.
-		$fields = $this->get_fields_for_response( $request );
-
-		// Prepare object data.
-		$context = ! empty( $request['context'] ) ? $request['context'] : 'view';
-		$data    = $this->prepare_object_data( $object, $fields, $context );
-		$data    = $this->add_additional_fields_to_object( $data, $request );
-		$data    = $this->limit_object_to_requested_fields( $data, $fields );
-		$data    = $this->filter_response_by_context( $data, $context );
-
-		// Prepare the response.
-		$response = rest_ensure_response( $data );
-		$response->add_links( $this->prepare_links( $object, $request ) );
-
-		// Filter item response.
-		return apply_filters( "getpaid_rest_prepare_{$this->rest_base}_object", $response, $object, $request );
-	}
+    /**
+     * Contains this controller's class name.
+     *
+     * @var string
+     */
+    public $crud_class;
+
+    /**
+     * Contains the current CRUD object.
+     *
+     * @var GetPaid_Data
+     */
+    protected $data_object;
+
+    /**
+     * Registers the routes for the objects of the controller.
+     *
+     * @since 1.0.19
+     *
+     * @see register_rest_route()
+     */
+    public function register_namespace_routes( $namespace ) {
+
+        register_rest_route(
+            $namespace,
+            '/' . $this->rest_base,
+            array(
+                array(
+                    'methods'             => WP_REST_Server::READABLE,
+                    'callback'            => array( $this, 'get_items' ),
+                    'permission_callback' => array( $this, 'get_items_permissions_check' ),
+                    'args'                => $this->get_collection_params(),
+                ),
+                array(
+                    'methods'             => WP_REST_Server::CREATABLE,
+                    'callback'            => array( $this, 'create_item' ),
+                    'permission_callback' => array( $this, 'create_item_permissions_check' ),
+                    'args'                => $this->get_endpoint_args_for_item_schema( WP_REST_Server::CREATABLE ),
+                ),
+                'schema' => array( $this, 'get_public_item_schema' ),
+            )
+        );
+
+        $get_item_args = array(
+            'context' => $this->get_context_param( array( 'default' => 'view' ) ),
+        );
+
+        register_rest_route(
+            $namespace,
+            '/' . $this->rest_base . '/(?P<id>[\d]+)',
+            array(
+                'args'   => array(
+                    'id' => array(
+                        'description' => __( 'Unique identifier for the object.', 'invoicing' ),
+                        'type'        => 'integer',
+                    ),
+                ),
+                array(
+                    'methods'             => WP_REST_Server::READABLE,
+                    'callback'            => array( $this, 'get_item' ),
+                    'permission_callback' => array( $this, 'get_item_permissions_check' ),
+                    'args'                => $get_item_args,
+                ),
+                array(
+                    'methods'             => WP_REST_Server::EDITABLE,
+                    'callback'            => array( $this, 'update_item' ),
+                    'permission_callback' => array( $this, 'update_item_permissions_check' ),
+                    'args'                => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ),
+                ),
+                array(
+                    'methods'             => WP_REST_Server::DELETABLE,
+                    'callback'            => array( $this, 'delete_item' ),
+                    'permission_callback' => array( $this, 'delete_item_permissions_check' ),
+                    'args'                => array(
+                        'force' => array(
+                            'type'        => 'boolean',
+                            'default'     => false,
+                            'description' => __( 'Whether to bypass Trash and force deletion.', 'invoicing' ),
+                        ),
+                    ),
+                ),
+                'schema' => array( $this, 'get_public_item_schema' ),
+            )
+        );
+
+    }
+
+    /**
+     * Saves a single object.
+     *
+     * @param GetPaid_Data $object Object to save.
+     * @return WP_Error|GetPaid_Data
+     */
+    protected function save_object( $object ) {
+        $object->save();
+
+        if ( ! empty( $object->last_error ) ) {
+            return new WP_Error( 'rest_cannot_save', $object->last_error, array( 'status' => 400 ) );
+        }
+
+        return new $this->crud_class( $object->get_id() );
+    }
+
+    /**
+     * Retrieves a single object.
+     *
+     * @since 1.0.13
+     *
+     * @param int|WP_Post $object_id Supplied ID.
+     * @return GetPaid_Data|WP_Error GetPaid_Data object if ID is valid, WP_Error otherwise.
+     */
+    protected function get_object( $object_id ) {
+
+        // Do we have an object?
+        if ( empty( $this->crud_class ) || ! class_exists( $this->crud_class ) ) {
+            return new WP_Error( 'no_crud_class', __( 'You need to specify a CRUD class for this controller', 'invoicing' ) );
+        }
+
+        // Fetch the object.
+        $object = new $this->crud_class( $object_id );
+        if ( ! empty( $object->last_error ) ) {
+            return new WP_Error( 'rest_object_invalid_id', $object->last_error, array( 'status' => 404 ) );
+        }
+
+        $this->data_object = $object;
+        return $object->get_id() ? $object : new WP_Error( 'rest_object_invalid_id', __( 'Invalid ID.', 'invoicing' ), array( 'status' => 404 ) );
+
+    }
+
+    /**
+     * 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 the item.
+        $object = $this->get_object( $request['id'] );
+
+        if ( is_wp_error( $object ) ) {
+            return $object;
+        }
+
+        // Generate a response.
+        return rest_ensure_response( $this->prepare_item_for_response( $object, $request ) );
+
+    }
+
+    /**
+     * 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 ) {
+
+        // Can not create an existing item.
+        if ( ! empty( $request['id'] ) ) {
+            /* translators: %s: post type */
+            return new WP_Error( "getpaid_rest_{$this->rest_base}_exists", __( 'Cannot create existing resource.', 'invoicing' ), array( 'status' => 400 ) );
+        }
+
+        // Generate a GetPaid_Data object from the request.
+        $object = $this->prepare_item_for_database( $request );
+        if ( is_wp_error( $object ) ) {
+            return $object;
+        }
+
+        // Save the object.
+        $object = $this->save_object( $object );
+        if ( is_wp_error( $object ) ) {
+            return $object;
+        }
+
+        // Save special fields.
+        $save_special = $this->update_additional_fields_for_object( $object, $request );
+        if ( is_wp_error( $save_special ) ) {
+            $object->delete( true );
+            return $save_special;
+        }
+
+        $request->set_param( 'context', 'edit' );
+        $response = $this->prepare_item_for_response( $object, $request );
+        $response = rest_ensure_response( $response );
+        $response->set_status( 201 );
+        $response->header( 'Location', rest_url( sprintf( '/%s/%s/%d', $this->namespace, $this->rest_base, $object->get_id() ) ) );
+
+        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 ) {
+
+        // Fetch the item.
+        $object = $this->get_object( $request['id'] );
+        if ( is_wp_error( $object ) ) {
+            return $object;
+        }
+
+        // Prepare the item for saving.
+        $object = $this->prepare_item_for_database( $request );
+        if ( is_wp_error( $object ) ) {
+            return $object;
+        }
+
+        // Save the item.
+        $object = $this->save_object( $object );
+        if ( is_wp_error( $object ) ) {
+            return $object;
+        }
+
+        // Save special fields (those added via hooks).
+        $save_special = $this->update_additional_fields_for_object( $object, $request );
+        if ( is_wp_error( $save_special ) ) {
+            return $save_special;
+        }
+
+        $request->set_param( 'context', 'edit' );
+        $response = $this->prepare_item_for_response( $object, $request );
+        return rest_ensure_response( $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 = array(
+            'self'       => array(
+                'href'   => rest_url( sprintf( '/%s/%s/%d', $this->namespace, $this->rest_base, $object->get_id() ) ),
+            ),
+            'collection' => array(
+                'href'   => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ),
+            ),
+        );
+
+        return $links;
+    }
+
+    /**
+     * Get the query params for collections of attachments.
+     *
+     * @return array
+     */
+    public function get_collection_params() {
+        $params = parent::get_collection_params();
+        $params['context']['default'] = 'view';
+        return $params;
+    }
+
+    /**
+     * Only return writable props from schema.
+     *
+     * @param  array $schema Schema.
+     * @return bool
+     */
+    public function filter_writable_props( $schema ) {
+        return empty( $schema['readonly'] );
+    }
+
+    /**
+     * Prepare a single object for create or update.
+     *
+     * @since 1.0.19
+     * @param  WP_REST_Request $request Request object.
+     * @return GetPaid_Data|WP_Error Data object or WP_Error.
+     */
+    protected function prepare_item_for_database( $request ) {
+
+        // Do we have an object?
+        if ( empty( $this->crud_class ) || ! class_exists( $this->crud_class ) ) {
+            return new WP_Error( 'no_crud_class', __( 'You need to specify a CRUD class for this controller', 'invoicing' ) );
+        }
+
+        // Prepare the object.
+        $id        = isset( $request['id'] ) ? absint( $request['id'] ) : 0;
+        $object    = new $this->crud_class( $id );
+
+        // Abort if an error exists.
+        if ( ! empty( $object->last_error ) ) {
+            return new WP_Error( 'invalid_item', $object->last_error );
+        }
+
+        $schema    = $this->get_item_schema();
+        $data_keys = array_keys( array_filter( $schema['properties'], array( $this, 'filter_writable_props' ) ) );
+
+        // Handle all writable props.
+        foreach ( $data_keys as $key ) {
+            $value = $request[ $key ];
+
+            if ( ! is_null( $value ) ) {
+                switch ( $key ) {
+
+                    case 'meta_data':
+                        if ( is_array( $value ) ) {
+                            foreach ( $value as $meta ) {
+                                $object->update_meta_data( $meta['key'], $meta['value'], isset( $meta['id'] ) ? $meta['id'] : '' );
+                            }
+                        }
+                        break;
+
+                    default:
+                        if ( is_callable( array( $object, "set_{$key}" ) ) ) {
+                            $object->{"set_{$key}"}( $value );
+                        }
+                        break;
+                }
+            }
+
+        }
+
+        // Filters an object before it is inserted via the REST API..
+        return apply_filters( "getpaid_rest_pre_insert_{$this->rest_base}_object", $object, $request );
+    }
+
+    /**
+     * Retrieves data from a GetPaid class.
+     *
+     * @since  1.0.19
+     * @param  GetPaid_Meta_Data[]    $meta_data  meta data objects.
+     * @return array
+     */
+    protected function prepare_object_meta_data( $meta_data ) {
+        $meta = array();
+
+        foreach( $meta_data as $object ) {
+            $meta[] = $object->get_data();
+        }
+
+        return $meta;
+    }
+
+    /**
+     * Retrieves invoice items.
+     *
+     * @since  1.0.19
+     * @param  WPInv_Invoice $invoice  Invoice items.
+     * @param array            $fields Fields to include.
+     * @return array
+     */
+    protected function prepare_invoice_items( $invoice ) {
+        $items = array();
+
+        foreach( $invoice->get_items() as $item ) {
+
+            $item_data = $item->prepare_data_for_saving();
+
+            if ( 'amount' == $invoice->get_template() ) {
+                $item_data['quantity'] = 1;
+            }
+
+            $items[] = $item_data;
+        }
+
+        return $items;
+    }
+
+    /**
+     * Retrieves data from a GetPaid class.
+     *
+     * @since  1.0.19
+     * @param  GetPaid_Data    $object  Data object.
+     * @param array            $fields Fields to include.
+     * @param string           $context either view or edit.
+     * @return array
+     */
+    protected function prepare_object_data( $object, $fields, $context = 'view' ) {
+
+        $data = array();
+
+        // Handle all writable props.
+        foreach ( array_keys( $this->get_schema_properties() ) as $key ) {
+
+            // Abort if it is not included.
+            if ( ! empty( $fields ) && ! $this->is_field_included( $key, $fields ) ) {
+                continue;
+            }
+
+            // Or this current object does not support the field.
+            if ( ! $this->object_supports_field( $object, $key ) ) {
+                continue;
+            }
+
+            // Handle meta data.
+            if ( $key == 'meta_data' ) {
+                $data['meta_data'] = $this->prepare_object_meta_data( $object->get_meta_data() );
+                continue;
+            }
+
+            // Handle items.
+            if ( $key == 'items' && is_a( $object, 'WPInv_Invoice' )  ) {
+                $data['items'] = $this->prepare_invoice_items( $object );
+                continue;
+            }
+
+            // Booleans.
+            if ( is_callable( array( $object, $key ) ) ) {
+                $data[ $key ] = $object->$key( $context );
+                continue;
+            }
+
+            // Get object value.
+            if ( is_callable( array( $object, "get_{$key}" ) ) ) {
+                $value = $object->{"get_{$key}"}( $context );
+
+                // If the value is an instance of GetPaid_Data...
+                if ( is_a( $value, 'GetPaid_Data' ) ) {
+                    $value = $value->get_data( $context );
+                }
+
+                // For objects, retrieves it's properties.
+                $data[ $key ] = is_object( $value ) ? get_object_vars( $value ) :  $value ;
+                continue;
+            }
+
+        }
+
+        return $data;
+    }
+
+    /**
+     * 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 ) {
+        return apply_filters( 'getpaid_rest_object_supports_key', true, $object, $field_key );
+    }
+
+    /**
+     * Prepare a single object output for response.
+     *
+     * @since  1.0.19
+     * @param  GetPaid_Data    $object  Data object.
+     * @param  WP_REST_Request $request Request object.
+     * @return WP_REST_Response
+     */
+    public function prepare_item_for_response( $object, $request ) {
+        remove_filter( 'rest_post_dispatch', 'rest_filter_response_fields', 10 );
+
+        $this->data_object = $object;
+
+        // Fetch the fields to include in this response.
+        $fields = $this->get_fields_for_response( $request );
+
+        // Prepare object data.
+        $context = ! empty( $request['context'] ) ? $request['context'] : 'view';
+        $data    = $this->prepare_object_data( $object, $fields, $context );
+        $data    = $this->add_additional_fields_to_object( $data, $request );
+        $data    = $this->limit_object_to_requested_fields( $data, $fields );
+        $data    = $this->filter_response_by_context( $data, $context );
+
+        // Prepare the response.
+        $response = rest_ensure_response( $data );
+        $response->add_links( $this->prepare_links( $object, $request ) );
+
+        // Filter item response.
+        return apply_filters( "getpaid_rest_prepare_{$this->rest_base}_object", $response, $object, $request );
+    }
 
 }

Spacing +117 added lines, -117 removed lines

@@ -8,7 +8,7 @@ 
  * @version 1.0.19
  */
 
-defined( 'ABSPATH' ) || exit;
+defined('ABSPATH') || exit;
 
 /**
  * GetPaid REST CRUD controller class.
@@ -38,7 +38,7 @@ 
 	 *
 	 * @see register_rest_route()
 	 */
-	public function register_namespace_routes( $namespace ) {
+	public function register_namespace_routes($namespace) {
 
 		register_rest_route(
 			$namespace,
@@ -46,22 +46,22 @@ 
 			array(
 				array(
 					'methods'             => WP_REST_Server::READABLE,
-					'callback'            => array( $this, 'get_items' ),
-					'permission_callback' => array( $this, 'get_items_permissions_check' ),
+					'callback'            => array($this, 'get_items'),
+					'permission_callback' => array($this, 'get_items_permissions_check'),
 					'args'                => $this->get_collection_params(),
 				),
 				array(
 					'methods'             => WP_REST_Server::CREATABLE,
-					'callback'            => array( $this, 'create_item' ),
-					'permission_callback' => array( $this, 'create_item_permissions_check' ),
-					'args'                => $this->get_endpoint_args_for_item_schema( WP_REST_Server::CREATABLE ),
+					'callback'            => array($this, 'create_item'),
+					'permission_callback' => array($this, 'create_item_permissions_check'),
+					'args'                => $this->get_endpoint_args_for_item_schema(WP_REST_Server::CREATABLE),
 				),
-				'schema' => array( $this, 'get_public_item_schema' ),
+				'schema' => array($this, 'get_public_item_schema'),
 			)
 		);
 
 		$get_item_args = array(
-			'context' => $this->get_context_param( array( 'default' => 'view' ) ),
+			'context' => $this->get_context_param(array('default' => 'view')),
 		);
 
 		register_rest_route(
@@ -70,35 +70,35 @@ 
 			array(
 				'args'   => array(
 					'id' => array(
-						'description' => __( 'Unique identifier for the object.', 'invoicing' ),
+						'description' => __('Unique identifier for the object.', 'invoicing'),
 						'type'        => 'integer',
 					),
 				),
 				array(
 					'methods'             => WP_REST_Server::READABLE,
-					'callback'            => array( $this, 'get_item' ),
-					'permission_callback' => array( $this, 'get_item_permissions_check' ),
+					'callback'            => array($this, 'get_item'),
+					'permission_callback' => array($this, 'get_item_permissions_check'),
 					'args'                => $get_item_args,
 				),
 				array(
 					'methods'             => WP_REST_Server::EDITABLE,
-					'callback'            => array( $this, 'update_item' ),
-					'permission_callback' => array( $this, 'update_item_permissions_check' ),
-					'args'                => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ),
+					'callback'            => array($this, 'update_item'),
+					'permission_callback' => array($this, 'update_item_permissions_check'),
+					'args'                => $this->get_endpoint_args_for_item_schema(WP_REST_Server::EDITABLE),
 				),
 				array(
 					'methods'             => WP_REST_Server::DELETABLE,
-					'callback'            => array( $this, 'delete_item' ),
-					'permission_callback' => array( $this, 'delete_item_permissions_check' ),
+					'callback'            => array($this, 'delete_item'),
+					'permission_callback' => array($this, 'delete_item_permissions_check'),
 					'args'                => array(
 						'force' => array(
 							'type'        => 'boolean',
 							'default'     => false,
-							'description' => __( 'Whether to bypass Trash and force deletion.', 'invoicing' ),
+							'description' => __('Whether to bypass Trash and force deletion.', 'invoicing'),
 						),
 					),
 				),
-				'schema' => array( $this, 'get_public_item_schema' ),
+				'schema' => array($this, 'get_public_item_schema'),
 			)
 		);
 
@@ -110,14 +110,14 @@ 
 	 * @param GetPaid_Data $object Object to save.
 	 * @return WP_Error|GetPaid_Data
 	 */
-	protected function save_object( $object ) {
+	protected function save_object($object) {
 		$object->save();
 
-		if ( ! empty( $object->last_error ) ) {
-			return new WP_Error( 'rest_cannot_save', $object->last_error, array( 'status' => 400 ) );
+		if (!empty($object->last_error)) {
+			return new WP_Error('rest_cannot_save', $object->last_error, array('status' => 400));
 		}
 
-		return new $this->crud_class( $object->get_id() );
+		return new $this->crud_class($object->get_id());
 	}
 
 	/**
@@ -128,21 +128,21 @@ 
 	 * @param int|WP_Post $object_id Supplied ID.
 	 * @return GetPaid_Data|WP_Error GetPaid_Data object if ID is valid, WP_Error otherwise.
 	 */
-	protected function get_object( $object_id ) {
+	protected function get_object($object_id) {
 
 		// Do we have an object?
-		if ( empty( $this->crud_class ) || ! class_exists( $this->crud_class ) ) {
-			return new WP_Error( 'no_crud_class', __( 'You need to specify a CRUD class for this controller', 'invoicing' ) );
+		if (empty($this->crud_class) || !class_exists($this->crud_class)) {
+			return new WP_Error('no_crud_class', __('You need to specify a CRUD class for this controller', 'invoicing'));
 		}
 
 		// Fetch the object.
-		$object = new $this->crud_class( $object_id );
-		if ( ! empty( $object->last_error ) ) {
-			return new WP_Error( 'rest_object_invalid_id', $object->last_error, array( 'status' => 404 ) );
+		$object = new $this->crud_class($object_id);
+		if (!empty($object->last_error)) {
+			return new WP_Error('rest_object_invalid_id', $object->last_error, array('status' => 404));
 		}
 
 		$this->data_object = $object;
-		return $object->get_id() ? $object : new WP_Error( 'rest_object_invalid_id', __( 'Invalid ID.', 'invoicing' ), array( 'status' => 404 ) );
+		return $object->get_id() ? $object : new WP_Error('rest_object_invalid_id', __('Invalid ID.', 'invoicing'), array('status' => 404));
 
 	}
 
@@ -152,17 +152,17 @@ 
 	 * @param WP_REST_Request $request Full details about the request.
 	 * @return WP_Error|WP_REST_Response
 	 */
-	public function get_item( $request ) {
+	public function get_item($request) {
 
 		// Fetch the item.
-		$object = $this->get_object( $request['id'] );
+		$object = $this->get_object($request['id']);
 
-		if ( is_wp_error( $object ) ) {
+		if (is_wp_error($object)) {
 			return $object;
 		}
 
 		// Generate a response.
-		return rest_ensure_response( $this->prepare_item_for_response( $object, $request ) );
+		return rest_ensure_response($this->prepare_item_for_response($object, $request));
 
 	}
 
@@ -172,38 +172,38 @@ 
 	 * @param WP_REST_Request $request Full details about the request.
 	 * @return WP_Error|WP_REST_Response
 	 */
-	public function create_item( $request ) {
+	public function create_item($request) {
 
 		// Can not create an existing item.
-		if ( ! empty( $request['id'] ) ) {
+		if (!empty($request['id'])) {
 			/* translators: %s: post type */
-			return new WP_Error( "getpaid_rest_{$this->rest_base}_exists", __( 'Cannot create existing resource.', 'invoicing' ), array( 'status' => 400 ) );
+			return new WP_Error("getpaid_rest_{$this->rest_base}_exists", __('Cannot create existing resource.', 'invoicing'), array('status' => 400));
 		}
 
 		// Generate a GetPaid_Data object from the request.
-		$object = $this->prepare_item_for_database( $request );
-		if ( is_wp_error( $object ) ) {
+		$object = $this->prepare_item_for_database($request);
+		if (is_wp_error($object)) {
 			return $object;
 		}
 
 		// Save the object.
-		$object = $this->save_object( $object );
-		if ( is_wp_error( $object ) ) {
+		$object = $this->save_object($object);
+		if (is_wp_error($object)) {
 			return $object;
 		}
 
 		// Save special fields.
-		$save_special = $this->update_additional_fields_for_object( $object, $request );
-		if ( is_wp_error( $save_special ) ) {
-			$object->delete( true );
+		$save_special = $this->update_additional_fields_for_object($object, $request);
+		if (is_wp_error($save_special)) {
+			$object->delete(true);
 			return $save_special;
 		}
 
-		$request->set_param( 'context', 'edit' );
-		$response = $this->prepare_item_for_response( $object, $request );
-		$response = rest_ensure_response( $response );
-		$response->set_status( 201 );
-		$response->header( 'Location', rest_url( sprintf( '/%s/%s/%d', $this->namespace, $this->rest_base, $object->get_id() ) ) );
+		$request->set_param('context', 'edit');
+		$response = $this->prepare_item_for_response($object, $request);
+		$response = rest_ensure_response($response);
+		$response->set_status(201);
+		$response->header('Location', rest_url(sprintf('/%s/%s/%d', $this->namespace, $this->rest_base, $object->get_id())));
 
 		return $response;
 	}
@@ -214,35 +214,35 @@ 
 	 * @param WP_REST_Request $request Full details about the request.
 	 * @return WP_Error|WP_REST_Response
 	 */
-	public function update_item( $request ) {
+	public function update_item($request) {
 
 		// Fetch the item.
-		$object = $this->get_object( $request['id'] );
-		if ( is_wp_error( $object ) ) {
+		$object = $this->get_object($request['id']);
+		if (is_wp_error($object)) {
 			return $object;
 		}
 
 		// Prepare the item for saving.
-		$object = $this->prepare_item_for_database( $request );
-		if ( is_wp_error( $object ) ) {
+		$object = $this->prepare_item_for_database($request);
+		if (is_wp_error($object)) {
 			return $object;
 		}
 
 		// Save the item.
-		$object = $this->save_object( $object );
-		if ( is_wp_error( $object ) ) {
+		$object = $this->save_object($object);
+		if (is_wp_error($object)) {
 			return $object;
 		}
 
 		// Save special fields (those added via hooks).
-		$save_special = $this->update_additional_fields_for_object( $object, $request );
-		if ( is_wp_error( $save_special ) ) {
+		$save_special = $this->update_additional_fields_for_object($object, $request);
+		if (is_wp_error($save_special)) {
 			return $save_special;
 		}
 
-		$request->set_param( 'context', 'edit' );
-		$response = $this->prepare_item_for_response( $object, $request );
-		return rest_ensure_response( $response );
+		$request->set_param('context', 'edit');
+		$response = $this->prepare_item_for_response($object, $request);
+		return rest_ensure_response($response);
 	}
 
 	/**
@@ -251,14 +251,14 @@ 
 	 * @param GetPaid_Data    $object GetPaid_Data object.
 	 * @return array Links for the given object.
 	 */
-	protected function prepare_links( $object ) {
+	protected function prepare_links($object) {
 
 		$links = array(
 			'self'       => array(
-				'href'   => rest_url( sprintf( '/%s/%s/%d', $this->namespace, $this->rest_base, $object->get_id() ) ),
+				'href'   => rest_url(sprintf('/%s/%s/%d', $this->namespace, $this->rest_base, $object->get_id())),
 			),
 			'collection' => array(
-				'href'   => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ),
+				'href'   => rest_url(sprintf('/%s/%s', $this->namespace, $this->rest_base)),
 			),
 		);
 
@@ -282,8 +282,8 @@ 
 	 * @param  array $schema Schema.
 	 * @return bool
 	 */
-	public function filter_writable_props( $schema ) {
-		return empty( $schema['readonly'] );
+	public function filter_writable_props($schema) {
+		return empty($schema['readonly']);
 	}
 
 	/**
@@ -293,43 +293,43 @@ 
 	 * @param  WP_REST_Request $request Request object.
 	 * @return GetPaid_Data|WP_Error Data object or WP_Error.
 	 */
-	protected function prepare_item_for_database( $request ) {
+	protected function prepare_item_for_database($request) {
 
 		// Do we have an object?
-		if ( empty( $this->crud_class ) || ! class_exists( $this->crud_class ) ) {
-			return new WP_Error( 'no_crud_class', __( 'You need to specify a CRUD class for this controller', 'invoicing' ) );
+		if (empty($this->crud_class) || !class_exists($this->crud_class)) {
+			return new WP_Error('no_crud_class', __('You need to specify a CRUD class for this controller', 'invoicing'));
 		}
 
 		// Prepare the object.
-		$id        = isset( $request['id'] ) ? absint( $request['id'] ) : 0;
-		$object    = new $this->crud_class( $id );
+		$id        = isset($request['id']) ? absint($request['id']) : 0;
+		$object    = new $this->crud_class($id);
 
 		// Abort if an error exists.
-		if ( ! empty( $object->last_error ) ) {
-			return new WP_Error( 'invalid_item', $object->last_error );
+		if (!empty($object->last_error)) {
+			return new WP_Error('invalid_item', $object->last_error);
 		}
 
 		$schema    = $this->get_item_schema();
-		$data_keys = array_keys( array_filter( $schema['properties'], array( $this, 'filter_writable_props' ) ) );
+		$data_keys = array_keys(array_filter($schema['properties'], array($this, 'filter_writable_props')));
 
 		// Handle all writable props.
-		foreach ( $data_keys as $key ) {
-			$value = $request[ $key ];
+		foreach ($data_keys as $key) {
+			$value = $request[$key];
 
-			if ( ! is_null( $value ) ) {
-				switch ( $key ) {
+			if (!is_null($value)) {
+				switch ($key) {
 
 					case 'meta_data':
-						if ( is_array( $value ) ) {
-							foreach ( $value as $meta ) {
-								$object->update_meta_data( $meta['key'], $meta['value'], isset( $meta['id'] ) ? $meta['id'] : '' );
+						if (is_array($value)) {
+							foreach ($value as $meta) {
+								$object->update_meta_data($meta['key'], $meta['value'], isset($meta['id']) ? $meta['id'] : '');
 							}
 						}
 						break;
 
 					default:
-						if ( is_callable( array( $object, "set_{$key}" ) ) ) {
-							$object->{"set_{$key}"}( $value );
+						if (is_callable(array($object, "set_{$key}"))) {
+							$object->{"set_{$key}"}($value);
 						}
 						break;
 				}
@@ -338,7 +338,7 @@ 
 		}
 
 		// Filters an object before it is inserted via the REST API..
-		return apply_filters( "getpaid_rest_pre_insert_{$this->rest_base}_object", $object, $request );
+		return apply_filters("getpaid_rest_pre_insert_{$this->rest_base}_object", $object, $request);
 	}
 
 	/**
@@ -348,10 +348,10 @@ 
 	 * @param  GetPaid_Meta_Data[]    $meta_data  meta data objects.
 	 * @return array
 	 */
-	protected function prepare_object_meta_data( $meta_data ) {
+	protected function prepare_object_meta_data($meta_data) {
 		$meta = array();
 
-		foreach( $meta_data as $object ) {
+		foreach ($meta_data as $object) {
 			$meta[] = $object->get_data();
 		}
 
@@ -366,14 +366,14 @@ 
 	 * @param array            $fields Fields to include.
 	 * @return array
 	 */
-	protected function prepare_invoice_items( $invoice ) {
+	protected function prepare_invoice_items($invoice) {
 		$items = array();
 
-		foreach( $invoice->get_items() as $item ) {
+		foreach ($invoice->get_items() as $item) {
 
 			$item_data = $item->prepare_data_for_saving();
 
-			if ( 'amount' == $invoice->get_template() ) {
+			if ('amount' == $invoice->get_template()) {
 				$item_data['quantity'] = 1;
 			}
 
@@ -392,52 +392,52 @@ 
 	 * @param string           $context either view or edit.
 	 * @return array
 	 */
-	protected function prepare_object_data( $object, $fields, $context = 'view' ) {
+	protected function prepare_object_data($object, $fields, $context = 'view') {
 
 		$data = array();
 
 		// Handle all writable props.
-		foreach ( array_keys( $this->get_schema_properties() ) as $key ) {
+		foreach (array_keys($this->get_schema_properties()) as $key) {
 
 			// Abort if it is not included.
-			if ( ! empty( $fields ) && ! $this->is_field_included( $key, $fields ) ) {
+			if (!empty($fields) && !$this->is_field_included($key, $fields)) {
 				continue;
 			}
 
 			// Or this current object does not support the field.
-			if ( ! $this->object_supports_field( $object, $key ) ) {
+			if (!$this->object_supports_field($object, $key)) {
 				continue;
 			}
 
 			// Handle meta data.
-			if ( $key == 'meta_data' ) {
-				$data['meta_data'] = $this->prepare_object_meta_data( $object->get_meta_data() );
+			if ($key == 'meta_data') {
+				$data['meta_data'] = $this->prepare_object_meta_data($object->get_meta_data());
 				continue;
 			}
 
 			// Handle items.
-			if ( $key == 'items' && is_a( $object, 'WPInv_Invoice' )  ) {
-				$data['items'] = $this->prepare_invoice_items( $object );
+			if ($key == 'items' && is_a($object, 'WPInv_Invoice')) {
+				$data['items'] = $this->prepare_invoice_items($object);
 				continue;
 			}
 
 			// Booleans.
-			if ( is_callable( array( $object, $key ) ) ) {
-				$data[ $key ] = $object->$key( $context );
+			if (is_callable(array($object, $key))) {
+				$data[$key] = $object->$key($context);
 				continue;
 			}
 
 			// Get object value.
-			if ( is_callable( array( $object, "get_{$key}" ) ) ) {
-				$value = $object->{"get_{$key}"}( $context );
+			if (is_callable(array($object, "get_{$key}"))) {
+				$value = $object->{"get_{$key}"}($context);
 
 				// If the value is an instance of GetPaid_Data...
-				if ( is_a( $value, 'GetPaid_Data' ) ) {
-					$value = $value->get_data( $context );
+				if (is_a($value, 'GetPaid_Data')) {
+					$value = $value->get_data($context);
 				}
 
 				// For objects, retrieves it's properties.
-				$data[ $key ] = is_object( $value ) ? get_object_vars( $value ) :  $value ;
+				$data[$key] = is_object($value) ? get_object_vars($value) : $value;
 				continue;
 			}
 
@@ -454,8 +454,8 @@ 
 	 * @param  string       $field_key The key to check for.
 	 * @return bool
 	 */
-	public function object_supports_field( $object, $field_key ) {
-		return apply_filters( 'getpaid_rest_object_supports_key', true, $object, $field_key );
+	public function object_supports_field($object, $field_key) {
+		return apply_filters('getpaid_rest_object_supports_key', true, $object, $field_key);
 	}
 
 	/**
@@ -466,27 +466,27 @@ 
 	 * @param  WP_REST_Request $request Request object.
 	 * @return WP_REST_Response
 	 */
-	public function prepare_item_for_response( $object, $request ) {
-		remove_filter( 'rest_post_dispatch', 'rest_filter_response_fields', 10 );
+	public function prepare_item_for_response($object, $request) {
+		remove_filter('rest_post_dispatch', 'rest_filter_response_fields', 10);
 
 		$this->data_object = $object;
 
 		// Fetch the fields to include in this response.
-		$fields = $this->get_fields_for_response( $request );
+		$fields = $this->get_fields_for_response($request);
 
 		// Prepare object data.
-		$context = ! empty( $request['context'] ) ? $request['context'] : 'view';
-		$data    = $this->prepare_object_data( $object, $fields, $context );
-		$data    = $this->add_additional_fields_to_object( $data, $request );
-		$data    = $this->limit_object_to_requested_fields( $data, $fields );
-		$data    = $this->filter_response_by_context( $data, $context );
+		$context = !empty($request['context']) ? $request['context'] : 'view';
+		$data    = $this->prepare_object_data($object, $fields, $context);
+		$data    = $this->add_additional_fields_to_object($data, $request);
+		$data    = $this->limit_object_to_requested_fields($data, $fields);
+		$data    = $this->filter_response_by_context($data, $context);
 
 		// Prepare the response.
-		$response = rest_ensure_response( $data );
-		$response->add_links( $this->prepare_links( $object, $request ) );
+		$response = rest_ensure_response($data);
+		$response->add_links($this->prepare_links($object, $request));
 
 		// Filter item response.
-		return apply_filters( "getpaid_rest_prepare_{$this->rest_base}_object", $response, $object, $request );
+		return apply_filters("getpaid_rest_prepare_{$this->rest_base}_object", $response, $object, $request);
 	}
 
 }

includes/class-getpaid-subscriptions-query.php

Indentation +490 added lines, -490 removed lines

@@ -16,495 +16,495 @@
  */
 class GetPaid_Subscriptions_Query {
 
-	/**
-	 * Query vars, after parsing
-	 *
-	 * @since 1.0.19
-	 * @var array
-	 */
-	public $query_vars = array();
-
-	/**
-	 * List of found subscriptions.
-	 *
-	 * @since 1.0.19
-	 * @var array
-	 */
-	private $results;
-
-	/**
-	 * Total number of found subscriptions for the current query
-	 *
-	 * @since 1.0.19
-	 * @var int
-	 */
-	private $total_subscriptions = 0;
-
-	/**
-	 * The SQL query used to fetch matching subscriptions.
-	 *
-	 * @since 1.0.19
-	 * @var string
-	 */
-	public $request;
-
-	// SQL clauses
-
-	/**
-	 * Contains the 'FIELDS' sql clause
-	 *
-	 * @since 1.0.19
-	 * @var string
-	 */
-	public $query_fields;
-
-	/**
-	 * Contains the 'FROM' sql clause
-	 *
-	 * @since 1.0.19
-	 * @var string
-	 */
-	public $query_from;
-
-	/**
-	 * Contains the 'WHERE' sql clause
-	 *
-	 * @since 1.0.19
-	 * @var string
-	 */
-	public $query_where;
-
-	/**
-	 * Contains the 'ORDER BY' sql clause
-	 *
-	 * @since 1.0.19
-	 * @var string
-	 */
-	public $query_orderby;
-
-	/**
-	 * Contains the 'LIMIT' sql clause
-	 *
-	 * @since 1.0.19
-	 * @var string
-	 */
-	public $query_limit;
-
-	/**
-	 * Class constructor.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @param null|string|array $query Optional. The query variables.
-	 */
-	public function __construct( $query = null ) {
-		if ( ! is_null( $query ) ) {
-			$this->prepare_query( $query );
-			$this->query();
-		}
-	}
-
-	/**
-	 * Fills in missing query variables with default values.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @param  string|array $args Query vars, as passed to `GetPaid_Subscriptions_Query`.
-	 * @return array Complete query variables with undefined ones filled in with defaults.
-	 */
-	public static function fill_query_vars( $args ) {
-		$defaults = array(
-			'status'            => 'all',
-			'customer_in'       => array(),
-			'customer_not_in'   => array(),
-			'product_in'        => array(),
-			'product_not_in'    => array(),
-			'include'           => array(),
-			'exclude'           => array(),
-			'orderby'           => 'id',
-			'order'             => 'DESC',
-			'offset'            => '',
-			'number'            => 10,
-			'paged'             => 1,
-			'count_total'       => true,
-			'fields'            => 'all',
-		);
-
-		return wp_parse_args( $args, $defaults );
-	}
-
-	/**
-	 * Prepare the query variables.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @global wpdb $wpdb WordPress database abstraction object.
-	 *
-	 * @param string|array $query {
-	 *     Optional. Array or string of Query parameters.
-	 *
-	 *     @type string|array $status              The subscription status to filter by. Can either be a single status or an array of statuses.
-	 *                                             Default is all.
-	 *     @type int[]        $customer_in         An array of customer ids to filter by.
-	 *     @type int[]        $customer_not_in     An array of customer ids whose subscriptions should be excluded.
-	 *     @type int[]        $invoice_in          An array of invoice ids to filter by.
-	 *     @type int[]        $invoice_not_in      An array of invoice ids whose subscriptions should be excluded.
-	 *     @type int[]        $product_in          An array of product ids to filter by.
-	 *     @type int[]        $product_not_in      An array of product ids whose subscriptions should be excluded.
-	 *     @type array        $date_created_query  A WP_Date_Query compatible array use to filter subscriptions by their date of creation.
-	 *     @type array        $date_expires_query  A WP_Date_Query compatible array use to filter subscriptions by their expiration date.
-	 *     @type array        $include             An array of subscription IDs to include. Default empty array.
-	 *     @type array        $exclude             An array of subscription IDs to exclude. Default empty array.
-	 *     @type string|array $orderby             Field(s) to sort the retrieved subscription by. May be a single value,
-	 *                                             an array of values, or a multi-dimensional array with fields as
-	 *                                             keys and orders ('ASC' or 'DESC') as values. Accepted values are
-	 *                                             'id', 'customer_id', 'frequency', 'period', 'initial_amount,
-	 *                                             'recurring_amount', 'bill_times', 'parent_payment_id', 'created', 'expiration'
-	 *                                             'transaction_id', 'product_id', 'trial_period', 'include', 'status', 'profile_id'. Default array( 'id' ).
-	 *     @type string       $order               Designates ascending or descending order of subscriptions. Order values
-	 *                                             passed as part of an `$orderby` array take precedence over this
-	 *                                             parameter. Accepts 'ASC', 'DESC'. Default 'DESC'.
-	 *     @type int          $offset              Number of subscriptions to offset in retrieved results. Can be used in
-	 *                                             conjunction with pagination. Default 0.
-	 *     @type int          $number              Number of subscriptions to limit the query for. Can be used in
-	 *                                             conjunction with pagination. Value -1 (all) is supported, but
-	 *                                             should be used with caution on larger sites.
-	 *                                             Default 10.
-	 *     @type int          $paged               When used with number, defines the page of results to return.
-	 *                                             Default 1.
-	 *     @type bool         $count_total         Whether to count the total number of subscriptions found. If pagination
-	 *                                             is not needed, setting this to false can improve performance.
-	 *                                             Default true.
-	 *     @type string|array $fields              Which fields to return. Single or all fields (string), or array
-	 *                                             of fields. Accepts 'id', 'customer_id', 'frequency', 'period', 'initial_amount,
-	 *                                             'recurring_amount', 'bill_times', 'parent_payment_id', 'created', 'expiration'
-	 *                                             'transaction_id', 'product_id', 'trial_period', 'status', 'profile_id'.
-	 *                                             Use 'all' for all fields. Default 'all'.
-	 * }
-	 */
-	public function prepare_query( $query = array() ) {
-		global $wpdb;
-
-		if ( empty( $this->query_vars ) || ! empty( $query ) ) {
-			$this->query_limit = null;
-			$this->query_vars  = $this->fill_query_vars( $query );
-		}
-
-		if ( ! empty( $this->query_vars['fields'] ) && 'all' !== $this->query_vars['fields'] ) {
-			$this->query_vars['fields'] = wpinv_parse_list( $this->query_vars['fields'] );
-		}
-
-		do_action( 'getpaid_pre_get_subscriptions', array( &$this ) );
-
-		// Ensure that query vars are filled after 'getpaid_pre_get_subscriptions'.
-		$qv                =& $this->query_vars;
-		$qv                = $this->fill_query_vars( $qv );
-		$table             = $wpdb->prefix . 'wpinv_subscriptions';
-		$this->query_from  = "FROM $table";
-
-		// Prepare query fields.
-		$this->prepare_query_fields( $qv, $table );
-
-		// Prepare query where.
-		$this->prepare_query_where( $qv, $table );
-
-		// Prepare query order.
-		$this->prepare_query_order( $qv, $table );
-
-		// limit
-		if ( isset( $qv['number'] ) && $qv['number'] > 0 ) {
-			if ( $qv['offset'] ) {
-				$this->query_limit = $wpdb->prepare( 'LIMIT %d, %d', $qv['offset'], $qv['number'] );
-			} else {
-				$this->query_limit = $wpdb->prepare( 'LIMIT %d, %d', $qv['number'] * ( $qv['paged'] - 1 ), $qv['number'] );
-			}
-		}
-
-		do_action_ref_array( 'getpaid_after_subscriptions_query', array( &$this ) );
-	}
-
-	/**
-	 * Prepares the query fields.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @param array $qv Query vars.
-	 * @param string $table Table name.
-	 */
-	protected function prepare_query_fields( &$qv, $table ) {
-
-		if ( is_array( $qv['fields'] ) ) {
-			$qv['fields'] = array_unique( $qv['fields'] );
-
-			$query_fields = array();
-			foreach ( $qv['fields'] as $field ) {
-				$field          = sanitize_key( $field );
-				$query_fields[] = "$table.`$field`";
-			}
-			$this->query_fields = implode( ',', $query_fields );
-		} else {
-			$this->query_fields = "$table.*";
-		}
-
-		if ( isset( $qv['count_total'] ) && $qv['count_total'] ) {
-			$this->query_fields = 'SQL_CALC_FOUND_ROWS ' . $this->query_fields;
-		}
-
-	}
-
-	/**
-	 * Prepares the query where.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @param array $qv Query vars.
-	 * @param string $table Table name.
-	 */
-	protected function prepare_query_where( &$qv, $table ) {
-		global $wpdb;
-		$this->query_where = 'WHERE 1=1';
-
-		// Status.
-		if ( 'all' !== $qv['status'] ) {
-			$statuses           = wpinv_clean( wpinv_parse_list( $qv['status'] ) );
-			$prepared_statuses  = join( ',', array_fill( 0, count( $statuses ), '%s' ) );
-			$this->query_where .= $wpdb->prepare( " AND $table.`status` IN ( $prepared_statuses )", $statuses );
-		}
-
-		if ( ! empty( $qv['customer_in'] ) ) {
-			$customer_in        = implode( ',', wp_parse_id_list( $qv['customer_in'] ) );
-			$this->query_where .= " AND $table.`customer_id` IN ($customer_in)";
-		} elseif ( ! empty( $qv['customer_not_in'] ) ) {
-			$customer_not_in    = implode( ',', wp_parse_id_list( $qv['customer_not_in'] ) );
-			$this->query_where .= " AND $table.`customer_id` NOT IN ($customer_not_in)";
-		}
-
-		if ( ! empty( $qv['product_in'] ) ) {
-			$product_in         = implode( ',', wp_parse_id_list( $qv['product_in'] ) );
-			$this->query_where .= " AND $table.`product_id` IN ($product_in)";
-		} elseif ( ! empty( $qv['product_not_in'] ) ) {
-			$product_not_in     = implode( ',', wp_parse_id_list( $qv['product_not_in'] ) );
-			$this->query_where .= " AND $table.`product_id` NOT IN ($product_not_in)";
-		}
-
-		if ( ! empty( $qv['invoice_in'] ) ) {
-			$invoice_in         = implode( ',', wp_parse_id_list( $qv['invoice_in'] ) );
-			$this->query_where .= " AND $table.`parent_payment_id` IN ($invoice_in)";
-		} elseif ( ! empty( $qv['invoice_not_in'] ) ) {
-			$invoice_not_in     = implode( ',', wp_parse_id_list( $qv['invoice_not_in'] ) );
-			$this->query_where .= " AND $table.`parent_payment_id` NOT IN ($invoice_not_in)";
-		}
-
-		if ( ! empty( $qv['include'] ) ) {
-			$include            = implode( ',', wp_parse_id_list( $qv['include'] ) );
-			$this->query_where .= " AND $table.`id` IN ($include)";
-		} elseif ( ! empty( $qv['exclude'] ) ) {
-			$exclude            = implode( ',', wp_parse_id_list( $qv['exclude'] ) );
-			$this->query_where .= " AND $table.`id` NOT IN ($exclude)";
-		}
-
-		// Date queries are allowed for the subscription creation date.
-		if ( ! empty( $qv['date_created_query'] ) && is_array( $qv['date_created_query'] ) ) {
-			$date_created_query = new WP_Date_Query( $qv['date_created_query'], "$table.created" );
-			$this->query_where .= $date_created_query->get_sql();
-		}
-
-		// Date queries are also allowed for the subscription expiration date.
-		if ( ! empty( $qv['date_expires_query'] ) && is_array( $qv['date_expires_query'] ) ) {
-			$date_expires_query = new WP_Date_Query( $qv['date_expires_query'], "$table.expiration" );
-			$this->query_where .= $date_expires_query->get_sql();
-		}
-
-	}
-
-	/**
-	 * Prepares the query order.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @param array $qv Query vars.
-	 * @param string $table Table name.
-	 */
-	protected function prepare_query_order( &$qv, $table ) {
-
-		// sorting.
-		$qv['order'] = isset( $qv['order'] ) ? strtoupper( $qv['order'] ) : '';
-		$order       = $this->parse_order( $qv['order'] );
-
-		// Default order is by 'id' (latest subscriptions).
-		if ( empty( $qv['orderby'] ) ) {
-			$qv['orderby'] = array( 'id' );
-		}
-
-		// 'orderby' values may be an array, comma- or space-separated list.
-		$ordersby      = array_filter( wpinv_parse_list(  $qv['orderby'] ) );
-
-		$orderby_array = array();
-		foreach ( $ordersby as $_key => $_value ) {
-
-			if ( is_int( $_key ) ) {
-				// Integer key means this is a flat array of 'orderby' fields.
-				$_orderby = $_value;
-				$_order   = $order;
-			} else {
-				// Non-integer key means that the key is the field and the value is ASC/DESC.
-				$_orderby = $_key;
-				$_order   = $_value;
-			}
-
-			$parsed = $this->parse_orderby( $_orderby, $table );
-
-			if ( $parsed ) {
-				$orderby_array[] = $parsed . ' ' . $this->parse_order( $_order );
-			}
-
-		}
-
-		// If no valid clauses were found, order by id.
-		if ( empty( $orderby_array ) ) {
-			$orderby_array[] = "id $order";
-		}
-
-		$this->query_orderby = 'ORDER BY ' . implode( ', ', $orderby_array );
-
-	}
-
-	/**
-	 * Execute the query, with the current variables.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @global wpdb $wpdb WordPress database abstraction object.
-	 */
-	public function query() {
-		global $wpdb;
-
-		$qv =& $this->query_vars;
-
-		// Return a non-null value to bypass the default GetPaid subscriptions query and remember to set the
-		// total_subscriptions property.
-		$this->results = apply_filters_ref_array( 'getpaid_subscriptions_pre_query', array( null, &$this ) );
-
-		if ( null === $this->results ) {
-			$this->request = "SELECT $this->query_fields $this->query_from $this->query_where $this->query_orderby $this->query_limit";
-
-			if ( ( is_array( $qv['fields'] ) && 1 != count( $qv['fields'] ) ) || 'all' == $qv['fields'] ) {
-				$this->results = $wpdb->get_results( $this->request );
-			} else {
-				$this->results = $wpdb->get_col( $this->request );
-			}
-
-			if ( isset( $qv['count_total'] ) && $qv['count_total'] ) {
-				$found_subscriptions_query = apply_filters( 'getpaid_found_subscriptions_query', 'SELECT FOUND_ROWS()', $this );
-				$this->total_subscriptions   = (int) $wpdb->get_var( $found_subscriptions_query );
-			}
-		}
-
-		if ( 'all' == $qv['fields'] ) {
-			foreach ( $this->results as $key => $subscription ) {
-				wp_cache_set( $subscription->id, $subscription, 'getpaid_subscriptions' );
-				wp_cache_set( $subscription->profile_id, $subscription->id, 'getpaid_subscription_profile_ids_to_subscription_ids' );
-				wp_cache_set( $subscription->transaction_id, $subscription->id, 'getpaid_subscription_transaction_ids_to_subscription_ids' );
-				wp_cache_set( $subscription->transaction_id, $subscription->id, 'getpaid_subscription_transaction_ids_to_subscription_ids' );
-				$this->results[ $key ] = new WPInv_Subscription( $subscription );
-			}
-		}
-
-	}
-
-	/**
-	 * Retrieve query variable.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @param string $query_var Query variable key.
-	 * @return mixed
-	 */
-	public function get( $query_var ) {
-		if ( isset( $this->query_vars[ $query_var ] ) ) {
-			return $this->query_vars[ $query_var ];
-		}
-
-		return null;
-	}
-
-	/**
-	 * Set query variable.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @param string $query_var Query variable key.
-	 * @param mixed $value Query variable value.
-	 */
-	public function set( $query_var, $value ) {
-		$this->query_vars[ $query_var ] = $value;
-	}
-
-	/**
-	 * Return the list of subscriptions.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @return WPInv_Subscription[]|array Found subscriptions.
-	 */
-	public function get_results() {
-		return $this->results;
-	}
-
-	/**
-	 * Return the total number of subscriptions for the current query.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @return int Number of total subscriptions.
-	 */
-	public function get_total() {
-		return $this->total_subscriptions;
-	}
-
-	/**
-	 * Parse and sanitize 'orderby' keys passed to the subscriptions query.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @param string $orderby Alias for the field to order by.
-	 *  @param string $table The current table.
-	 * @return string Value to use in the ORDER clause, if `$orderby` is valid.
-	 */
-	protected function parse_orderby( $orderby, $table ) {
-
-		$_orderby = '';
-		if ( in_array( $orderby, array( 'customer_id', 'frequency', 'period', 'initial_amount', 'recurring_amount', 'bill_times', 'transaction_id', 'parent_payment_id', 'product_id', 'created', 'expiration', 'trial_period', 'status', 'profile_id' ) ) ) {
-			$_orderby = "$table.`$orderby`";
-		} elseif ( 'id' === strtolower( $orderby ) ) {
-			$_orderby = "$table.id";
-		} elseif ( 'include' === $orderby && ! empty( $this->query_vars['include'] ) ) {
-			$include     = wp_parse_id_list( $this->query_vars['include'] );
-			$include_sql = implode( ',', $include );
-			$_orderby    = "FIELD( $table.id, $include_sql )";
-		}
-
-		return $_orderby;
-	}
-
-	/**
-	 * Parse an 'order' query variable and cast it to ASC or DESC as necessary.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @param string $order The 'order' query variable.
-	 * @return string The sanitized 'order' query variable.
-	 */
-	protected function parse_order( $order ) {
-		if ( ! is_string( $order ) || empty( $order ) ) {
-			return 'DESC';
-		}
-
-		if ( 'ASC' === strtoupper( $order ) ) {
-			return 'ASC';
-		} else {
-			return 'DESC';
-		}
-	}
+    /**
+     * Query vars, after parsing
+     *
+     * @since 1.0.19
+     * @var array
+     */
+    public $query_vars = array();
+
+    /**
+     * List of found subscriptions.
+     *
+     * @since 1.0.19
+     * @var array
+     */
+    private $results;
+
+    /**
+     * Total number of found subscriptions for the current query
+     *
+     * @since 1.0.19
+     * @var int
+     */
+    private $total_subscriptions = 0;
+
+    /**
+     * The SQL query used to fetch matching subscriptions.
+     *
+     * @since 1.0.19
+     * @var string
+     */
+    public $request;
+
+    // SQL clauses
+
+    /**
+     * Contains the 'FIELDS' sql clause
+     *
+     * @since 1.0.19
+     * @var string
+     */
+    public $query_fields;
+
+    /**
+     * Contains the 'FROM' sql clause
+     *
+     * @since 1.0.19
+     * @var string
+     */
+    public $query_from;
+
+    /**
+     * Contains the 'WHERE' sql clause
+     *
+     * @since 1.0.19
+     * @var string
+     */
+    public $query_where;
+
+    /**
+     * Contains the 'ORDER BY' sql clause
+     *
+     * @since 1.0.19
+     * @var string
+     */
+    public $query_orderby;
+
+    /**
+     * Contains the 'LIMIT' sql clause
+     *
+     * @since 1.0.19
+     * @var string
+     */
+    public $query_limit;
+
+    /**
+     * Class constructor.
+     *
+     * @since 1.0.19
+     *
+     * @param null|string|array $query Optional. The query variables.
+     */
+    public function __construct( $query = null ) {
+        if ( ! is_null( $query ) ) {
+            $this->prepare_query( $query );
+            $this->query();
+        }
+    }
+
+    /**
+     * Fills in missing query variables with default values.
+     *
+     * @since 1.0.19
+     *
+     * @param  string|array $args Query vars, as passed to `GetPaid_Subscriptions_Query`.
+     * @return array Complete query variables with undefined ones filled in with defaults.
+     */
+    public static function fill_query_vars( $args ) {
+        $defaults = array(
+            'status'            => 'all',
+            'customer_in'       => array(),
+            'customer_not_in'   => array(),
+            'product_in'        => array(),
+            'product_not_in'    => array(),
+            'include'           => array(),
+            'exclude'           => array(),
+            'orderby'           => 'id',
+            'order'             => 'DESC',
+            'offset'            => '',
+            'number'            => 10,
+            'paged'             => 1,
+            'count_total'       => true,
+            'fields'            => 'all',
+        );
+
+        return wp_parse_args( $args, $defaults );
+    }
+
+    /**
+     * Prepare the query variables.
+     *
+     * @since 1.0.19
+     *
+     * @global wpdb $wpdb WordPress database abstraction object.
+     *
+     * @param string|array $query {
+     *     Optional. Array or string of Query parameters.
+     *
+     *     @type string|array $status              The subscription status to filter by. Can either be a single status or an array of statuses.
+     *                                             Default is all.
+     *     @type int[]        $customer_in         An array of customer ids to filter by.
+     *     @type int[]        $customer_not_in     An array of customer ids whose subscriptions should be excluded.
+     *     @type int[]        $invoice_in          An array of invoice ids to filter by.
+     *     @type int[]        $invoice_not_in      An array of invoice ids whose subscriptions should be excluded.
+     *     @type int[]        $product_in          An array of product ids to filter by.
+     *     @type int[]        $product_not_in      An array of product ids whose subscriptions should be excluded.
+     *     @type array        $date_created_query  A WP_Date_Query compatible array use to filter subscriptions by their date of creation.
+     *     @type array        $date_expires_query  A WP_Date_Query compatible array use to filter subscriptions by their expiration date.
+     *     @type array        $include             An array of subscription IDs to include. Default empty array.
+     *     @type array        $exclude             An array of subscription IDs to exclude. Default empty array.
+     *     @type string|array $orderby             Field(s) to sort the retrieved subscription by. May be a single value,
+     *                                             an array of values, or a multi-dimensional array with fields as
+     *                                             keys and orders ('ASC' or 'DESC') as values. Accepted values are
+     *                                             'id', 'customer_id', 'frequency', 'period', 'initial_amount,
+     *                                             'recurring_amount', 'bill_times', 'parent_payment_id', 'created', 'expiration'
+     *                                             'transaction_id', 'product_id', 'trial_period', 'include', 'status', 'profile_id'. Default array( 'id' ).
+     *     @type string       $order               Designates ascending or descending order of subscriptions. Order values
+     *                                             passed as part of an `$orderby` array take precedence over this
+     *                                             parameter. Accepts 'ASC', 'DESC'. Default 'DESC'.
+     *     @type int          $offset              Number of subscriptions to offset in retrieved results. Can be used in
+     *                                             conjunction with pagination. Default 0.
+     *     @type int          $number              Number of subscriptions to limit the query for. Can be used in
+     *                                             conjunction with pagination. Value -1 (all) is supported, but
+     *                                             should be used with caution on larger sites.
+     *                                             Default 10.
+     *     @type int          $paged               When used with number, defines the page of results to return.
+     *                                             Default 1.
+     *     @type bool         $count_total         Whether to count the total number of subscriptions found. If pagination
+     *                                             is not needed, setting this to false can improve performance.
+     *                                             Default true.
+     *     @type string|array $fields              Which fields to return. Single or all fields (string), or array
+     *                                             of fields. Accepts 'id', 'customer_id', 'frequency', 'period', 'initial_amount,
+     *                                             'recurring_amount', 'bill_times', 'parent_payment_id', 'created', 'expiration'
+     *                                             'transaction_id', 'product_id', 'trial_period', 'status', 'profile_id'.
+     *                                             Use 'all' for all fields. Default 'all'.
+     * }
+     */
+    public function prepare_query( $query = array() ) {
+        global $wpdb;
+
+        if ( empty( $this->query_vars ) || ! empty( $query ) ) {
+            $this->query_limit = null;
+            $this->query_vars  = $this->fill_query_vars( $query );
+        }
+
+        if ( ! empty( $this->query_vars['fields'] ) && 'all' !== $this->query_vars['fields'] ) {
+            $this->query_vars['fields'] = wpinv_parse_list( $this->query_vars['fields'] );
+        }
+
+        do_action( 'getpaid_pre_get_subscriptions', array( &$this ) );
+
+        // Ensure that query vars are filled after 'getpaid_pre_get_subscriptions'.
+        $qv                =& $this->query_vars;
+        $qv                = $this->fill_query_vars( $qv );
+        $table             = $wpdb->prefix . 'wpinv_subscriptions';
+        $this->query_from  = "FROM $table";
+
+        // Prepare query fields.
+        $this->prepare_query_fields( $qv, $table );
+
+        // Prepare query where.
+        $this->prepare_query_where( $qv, $table );
+
+        // Prepare query order.
+        $this->prepare_query_order( $qv, $table );
+
+        // limit
+        if ( isset( $qv['number'] ) && $qv['number'] > 0 ) {
+            if ( $qv['offset'] ) {
+                $this->query_limit = $wpdb->prepare( 'LIMIT %d, %d', $qv['offset'], $qv['number'] );
+            } else {
+                $this->query_limit = $wpdb->prepare( 'LIMIT %d, %d', $qv['number'] * ( $qv['paged'] - 1 ), $qv['number'] );
+            }
+        }
+
+        do_action_ref_array( 'getpaid_after_subscriptions_query', array( &$this ) );
+    }
+
+    /**
+     * Prepares the query fields.
+     *
+     * @since 1.0.19
+     *
+     * @param array $qv Query vars.
+     * @param string $table Table name.
+     */
+    protected function prepare_query_fields( &$qv, $table ) {
+
+        if ( is_array( $qv['fields'] ) ) {
+            $qv['fields'] = array_unique( $qv['fields'] );
+
+            $query_fields = array();
+            foreach ( $qv['fields'] as $field ) {
+                $field          = sanitize_key( $field );
+                $query_fields[] = "$table.`$field`";
+            }
+            $this->query_fields = implode( ',', $query_fields );
+        } else {
+            $this->query_fields = "$table.*";
+        }
+
+        if ( isset( $qv['count_total'] ) && $qv['count_total'] ) {
+            $this->query_fields = 'SQL_CALC_FOUND_ROWS ' . $this->query_fields;
+        }
+
+    }
+
+    /**
+     * Prepares the query where.
+     *
+     * @since 1.0.19
+     *
+     * @param array $qv Query vars.
+     * @param string $table Table name.
+     */
+    protected function prepare_query_where( &$qv, $table ) {
+        global $wpdb;
+        $this->query_where = 'WHERE 1=1';
+
+        // Status.
+        if ( 'all' !== $qv['status'] ) {
+            $statuses           = wpinv_clean( wpinv_parse_list( $qv['status'] ) );
+            $prepared_statuses  = join( ',', array_fill( 0, count( $statuses ), '%s' ) );
+            $this->query_where .= $wpdb->prepare( " AND $table.`status` IN ( $prepared_statuses )", $statuses );
+        }
+
+        if ( ! empty( $qv['customer_in'] ) ) {
+            $customer_in        = implode( ',', wp_parse_id_list( $qv['customer_in'] ) );
+            $this->query_where .= " AND $table.`customer_id` IN ($customer_in)";
+        } elseif ( ! empty( $qv['customer_not_in'] ) ) {
+            $customer_not_in    = implode( ',', wp_parse_id_list( $qv['customer_not_in'] ) );
+            $this->query_where .= " AND $table.`customer_id` NOT IN ($customer_not_in)";
+        }
+
+        if ( ! empty( $qv['product_in'] ) ) {
+            $product_in         = implode( ',', wp_parse_id_list( $qv['product_in'] ) );
+            $this->query_where .= " AND $table.`product_id` IN ($product_in)";
+        } elseif ( ! empty( $qv['product_not_in'] ) ) {
+            $product_not_in     = implode( ',', wp_parse_id_list( $qv['product_not_in'] ) );
+            $this->query_where .= " AND $table.`product_id` NOT IN ($product_not_in)";
+        }
+
+        if ( ! empty( $qv['invoice_in'] ) ) {
+            $invoice_in         = implode( ',', wp_parse_id_list( $qv['invoice_in'] ) );
+            $this->query_where .= " AND $table.`parent_payment_id` IN ($invoice_in)";
+        } elseif ( ! empty( $qv['invoice_not_in'] ) ) {
+            $invoice_not_in     = implode( ',', wp_parse_id_list( $qv['invoice_not_in'] ) );
+            $this->query_where .= " AND $table.`parent_payment_id` NOT IN ($invoice_not_in)";
+        }
+
+        if ( ! empty( $qv['include'] ) ) {
+            $include            = implode( ',', wp_parse_id_list( $qv['include'] ) );
+            $this->query_where .= " AND $table.`id` IN ($include)";
+        } elseif ( ! empty( $qv['exclude'] ) ) {
+            $exclude            = implode( ',', wp_parse_id_list( $qv['exclude'] ) );
+            $this->query_where .= " AND $table.`id` NOT IN ($exclude)";
+        }
+
+        // Date queries are allowed for the subscription creation date.
+        if ( ! empty( $qv['date_created_query'] ) && is_array( $qv['date_created_query'] ) ) {
+            $date_created_query = new WP_Date_Query( $qv['date_created_query'], "$table.created" );
+            $this->query_where .= $date_created_query->get_sql();
+        }
+
+        // Date queries are also allowed for the subscription expiration date.
+        if ( ! empty( $qv['date_expires_query'] ) && is_array( $qv['date_expires_query'] ) ) {
+            $date_expires_query = new WP_Date_Query( $qv['date_expires_query'], "$table.expiration" );
+            $this->query_where .= $date_expires_query->get_sql();
+        }
+
+    }
+
+    /**
+     * Prepares the query order.
+     *
+     * @since 1.0.19
+     *
+     * @param array $qv Query vars.
+     * @param string $table Table name.
+     */
+    protected function prepare_query_order( &$qv, $table ) {
+
+        // sorting.
+        $qv['order'] = isset( $qv['order'] ) ? strtoupper( $qv['order'] ) : '';
+        $order       = $this->parse_order( $qv['order'] );
+
+        // Default order is by 'id' (latest subscriptions).
+        if ( empty( $qv['orderby'] ) ) {
+            $qv['orderby'] = array( 'id' );
+        }
+
+        // 'orderby' values may be an array, comma- or space-separated list.
+        $ordersby      = array_filter( wpinv_parse_list(  $qv['orderby'] ) );
+
+        $orderby_array = array();
+        foreach ( $ordersby as $_key => $_value ) {
+
+            if ( is_int( $_key ) ) {
+                // Integer key means this is a flat array of 'orderby' fields.
+                $_orderby = $_value;
+                $_order   = $order;
+            } else {
+                // Non-integer key means that the key is the field and the value is ASC/DESC.
+                $_orderby = $_key;
+                $_order   = $_value;
+            }
+
+            $parsed = $this->parse_orderby( $_orderby, $table );
+
+            if ( $parsed ) {
+                $orderby_array[] = $parsed . ' ' . $this->parse_order( $_order );
+            }
+
+        }
+
+        // If no valid clauses were found, order by id.
+        if ( empty( $orderby_array ) ) {
+            $orderby_array[] = "id $order";
+        }
+
+        $this->query_orderby = 'ORDER BY ' . implode( ', ', $orderby_array );
+
+    }
+
+    /**
+     * Execute the query, with the current variables.
+     *
+     * @since 1.0.19
+     *
+     * @global wpdb $wpdb WordPress database abstraction object.
+     */
+    public function query() {
+        global $wpdb;
+
+        $qv =& $this->query_vars;
+
+        // Return a non-null value to bypass the default GetPaid subscriptions query and remember to set the
+        // total_subscriptions property.
+        $this->results = apply_filters_ref_array( 'getpaid_subscriptions_pre_query', array( null, &$this ) );
+
+        if ( null === $this->results ) {
+            $this->request = "SELECT $this->query_fields $this->query_from $this->query_where $this->query_orderby $this->query_limit";
+
+            if ( ( is_array( $qv['fields'] ) && 1 != count( $qv['fields'] ) ) || 'all' == $qv['fields'] ) {
+                $this->results = $wpdb->get_results( $this->request );
+            } else {
+                $this->results = $wpdb->get_col( $this->request );
+            }
+
+            if ( isset( $qv['count_total'] ) && $qv['count_total'] ) {
+                $found_subscriptions_query = apply_filters( 'getpaid_found_subscriptions_query', 'SELECT FOUND_ROWS()', $this );
+                $this->total_subscriptions   = (int) $wpdb->get_var( $found_subscriptions_query );
+            }
+        }
+
+        if ( 'all' == $qv['fields'] ) {
+            foreach ( $this->results as $key => $subscription ) {
+                wp_cache_set( $subscription->id, $subscription, 'getpaid_subscriptions' );
+                wp_cache_set( $subscription->profile_id, $subscription->id, 'getpaid_subscription_profile_ids_to_subscription_ids' );
+                wp_cache_set( $subscription->transaction_id, $subscription->id, 'getpaid_subscription_transaction_ids_to_subscription_ids' );
+                wp_cache_set( $subscription->transaction_id, $subscription->id, 'getpaid_subscription_transaction_ids_to_subscription_ids' );
+                $this->results[ $key ] = new WPInv_Subscription( $subscription );
+            }
+        }
+
+    }
+
+    /**
+     * Retrieve query variable.
+     *
+     * @since 1.0.19
+     *
+     * @param string $query_var Query variable key.
+     * @return mixed
+     */
+    public function get( $query_var ) {
+        if ( isset( $this->query_vars[ $query_var ] ) ) {
+            return $this->query_vars[ $query_var ];
+        }
+
+        return null;
+    }
+
+    /**
+     * Set query variable.
+     *
+     * @since 1.0.19
+     *
+     * @param string $query_var Query variable key.
+     * @param mixed $value Query variable value.
+     */
+    public function set( $query_var, $value ) {
+        $this->query_vars[ $query_var ] = $value;
+    }
+
+    /**
+     * Return the list of subscriptions.
+     *
+     * @since 1.0.19
+     *
+     * @return WPInv_Subscription[]|array Found subscriptions.
+     */
+    public function get_results() {
+        return $this->results;
+    }
+
+    /**
+     * Return the total number of subscriptions for the current query.
+     *
+     * @since 1.0.19
+     *
+     * @return int Number of total subscriptions.
+     */
+    public function get_total() {
+        return $this->total_subscriptions;
+    }
+
+    /**
+     * Parse and sanitize 'orderby' keys passed to the subscriptions query.
+     *
+     * @since 1.0.19
+     *
+     * @param string $orderby Alias for the field to order by.
+     *  @param string $table The current table.
+     * @return string Value to use in the ORDER clause, if `$orderby` is valid.
+     */
+    protected function parse_orderby( $orderby, $table ) {
+
+        $_orderby = '';
+        if ( in_array( $orderby, array( 'customer_id', 'frequency', 'period', 'initial_amount', 'recurring_amount', 'bill_times', 'transaction_id', 'parent_payment_id', 'product_id', 'created', 'expiration', 'trial_period', 'status', 'profile_id' ) ) ) {
+            $_orderby = "$table.`$orderby`";
+        } elseif ( 'id' === strtolower( $orderby ) ) {
+            $_orderby = "$table.id";
+        } elseif ( 'include' === $orderby && ! empty( $this->query_vars['include'] ) ) {
+            $include     = wp_parse_id_list( $this->query_vars['include'] );
+            $include_sql = implode( ',', $include );
+            $_orderby    = "FIELD( $table.id, $include_sql )";
+        }
+
+        return $_orderby;
+    }
+
+    /**
+     * Parse an 'order' query variable and cast it to ASC or DESC as necessary.
+     *
+     * @since 1.0.19
+     *
+     * @param string $order The 'order' query variable.
+     * @return string The sanitized 'order' query variable.
+     */
+    protected function parse_order( $order ) {
+        if ( ! is_string( $order ) || empty( $order ) ) {
+            return 'DESC';
+        }
+
+        if ( 'ASC' === strtoupper( $order ) ) {
+            return 'ASC';
+        } else {
+            return 'DESC';
+        }
+    }
 
 }

Spacing +96 added lines, -96 removed lines

@@ -97,9 +97,9 @@ 
 	 *
 	 * @param null|string|array $query Optional. The query variables.
 	 */
-	public function __construct( $query = null ) {
-		if ( ! is_null( $query ) ) {
-			$this->prepare_query( $query );
+	public function __construct($query = null) {
+		if (!is_null($query)) {
+			$this->prepare_query($query);
 			$this->query();
 		}
 	}
@@ -112,7 +112,7 @@ 
 	 * @param  string|array $args Query vars, as passed to `GetPaid_Subscriptions_Query`.
 	 * @return array Complete query variables with undefined ones filled in with defaults.
 	 */
-	public static function fill_query_vars( $args ) {
+	public static function fill_query_vars($args) {
 		$defaults = array(
 			'status'            => 'all',
 			'customer_in'       => array(),
@@ -130,7 +130,7 @@ 
 			'fields'            => 'all',
 		);
 
-		return wp_parse_args( $args, $defaults );
+		return wp_parse_args($args, $defaults);
 	}
 
 	/**
@@ -182,45 +182,45 @@ 
 	 *                                             Use 'all' for all fields. Default 'all'.
 	 * }
 	 */
-	public function prepare_query( $query = array() ) {
+	public function prepare_query($query = array()) {
 		global $wpdb;
 
-		if ( empty( $this->query_vars ) || ! empty( $query ) ) {
+		if (empty($this->query_vars) || !empty($query)) {
 			$this->query_limit = null;
-			$this->query_vars  = $this->fill_query_vars( $query );
+			$this->query_vars  = $this->fill_query_vars($query);
 		}
 
-		if ( ! empty( $this->query_vars['fields'] ) && 'all' !== $this->query_vars['fields'] ) {
-			$this->query_vars['fields'] = wpinv_parse_list( $this->query_vars['fields'] );
+		if (!empty($this->query_vars['fields']) && 'all' !== $this->query_vars['fields']) {
+			$this->query_vars['fields'] = wpinv_parse_list($this->query_vars['fields']);
 		}
 
-		do_action( 'getpaid_pre_get_subscriptions', array( &$this ) );
+		do_action('getpaid_pre_get_subscriptions', array(&$this));
 
 		// Ensure that query vars are filled after 'getpaid_pre_get_subscriptions'.
-		$qv                =& $this->query_vars;
-		$qv                = $this->fill_query_vars( $qv );
+		$qv                = & $this->query_vars;
+		$qv                = $this->fill_query_vars($qv);
 		$table             = $wpdb->prefix . 'wpinv_subscriptions';
 		$this->query_from  = "FROM $table";
 
 		// Prepare query fields.
-		$this->prepare_query_fields( $qv, $table );
+		$this->prepare_query_fields($qv, $table);
 
 		// Prepare query where.
-		$this->prepare_query_where( $qv, $table );
+		$this->prepare_query_where($qv, $table);
 
 		// Prepare query order.
-		$this->prepare_query_order( $qv, $table );
+		$this->prepare_query_order($qv, $table);
 
 		// limit
-		if ( isset( $qv['number'] ) && $qv['number'] > 0 ) {
-			if ( $qv['offset'] ) {
-				$this->query_limit = $wpdb->prepare( 'LIMIT %d, %d', $qv['offset'], $qv['number'] );
+		if (isset($qv['number']) && $qv['number'] > 0) {
+			if ($qv['offset']) {
+				$this->query_limit = $wpdb->prepare('LIMIT %d, %d', $qv['offset'], $qv['number']);
 			} else {
-				$this->query_limit = $wpdb->prepare( 'LIMIT %d, %d', $qv['number'] * ( $qv['paged'] - 1 ), $qv['number'] );
+				$this->query_limit = $wpdb->prepare('LIMIT %d, %d', $qv['number'] * ($qv['paged'] - 1), $qv['number']);
 			}
 		}
 
-		do_action_ref_array( 'getpaid_after_subscriptions_query', array( &$this ) );
+		do_action_ref_array('getpaid_after_subscriptions_query', array(&$this));
 	}
 
 	/**
@@ -231,22 +231,22 @@ 
 	 * @param array $qv Query vars.
 	 * @param string $table Table name.
 	 */
-	protected function prepare_query_fields( &$qv, $table ) {
+	protected function prepare_query_fields(&$qv, $table) {
 
-		if ( is_array( $qv['fields'] ) ) {
-			$qv['fields'] = array_unique( $qv['fields'] );
+		if (is_array($qv['fields'])) {
+			$qv['fields'] = array_unique($qv['fields']);
 
 			$query_fields = array();
-			foreach ( $qv['fields'] as $field ) {
-				$field          = sanitize_key( $field );
+			foreach ($qv['fields'] as $field) {
+				$field          = sanitize_key($field);
 				$query_fields[] = "$table.`$field`";
 			}
-			$this->query_fields = implode( ',', $query_fields );
+			$this->query_fields = implode(',', $query_fields);
 		} else {
 			$this->query_fields = "$table.*";
 		}
 
-		if ( isset( $qv['count_total'] ) && $qv['count_total'] ) {
+		if (isset($qv['count_total']) && $qv['count_total']) {
 			$this->query_fields = 'SQL_CALC_FOUND_ROWS ' . $this->query_fields;
 		}
 
@@ -260,58 +260,58 @@ 
 	 * @param array $qv Query vars.
 	 * @param string $table Table name.
 	 */
-	protected function prepare_query_where( &$qv, $table ) {
+	protected function prepare_query_where(&$qv, $table) {
 		global $wpdb;
 		$this->query_where = 'WHERE 1=1';
 
 		// Status.
-		if ( 'all' !== $qv['status'] ) {
-			$statuses           = wpinv_clean( wpinv_parse_list( $qv['status'] ) );
-			$prepared_statuses  = join( ',', array_fill( 0, count( $statuses ), '%s' ) );
-			$this->query_where .= $wpdb->prepare( " AND $table.`status` IN ( $prepared_statuses )", $statuses );
+		if ('all' !== $qv['status']) {
+			$statuses           = wpinv_clean(wpinv_parse_list($qv['status']));
+			$prepared_statuses  = join(',', array_fill(0, count($statuses), '%s'));
+			$this->query_where .= $wpdb->prepare(" AND $table.`status` IN ( $prepared_statuses )", $statuses);
 		}
 
-		if ( ! empty( $qv['customer_in'] ) ) {
-			$customer_in        = implode( ',', wp_parse_id_list( $qv['customer_in'] ) );
+		if (!empty($qv['customer_in'])) {
+			$customer_in        = implode(',', wp_parse_id_list($qv['customer_in']));
 			$this->query_where .= " AND $table.`customer_id` IN ($customer_in)";
-		} elseif ( ! empty( $qv['customer_not_in'] ) ) {
-			$customer_not_in    = implode( ',', wp_parse_id_list( $qv['customer_not_in'] ) );
+		} elseif (!empty($qv['customer_not_in'])) {
+			$customer_not_in    = implode(',', wp_parse_id_list($qv['customer_not_in']));
 			$this->query_where .= " AND $table.`customer_id` NOT IN ($customer_not_in)";
 		}
 
-		if ( ! empty( $qv['product_in'] ) ) {
-			$product_in         = implode( ',', wp_parse_id_list( $qv['product_in'] ) );
+		if (!empty($qv['product_in'])) {
+			$product_in         = implode(',', wp_parse_id_list($qv['product_in']));
 			$this->query_where .= " AND $table.`product_id` IN ($product_in)";
-		} elseif ( ! empty( $qv['product_not_in'] ) ) {
-			$product_not_in     = implode( ',', wp_parse_id_list( $qv['product_not_in'] ) );
+		} elseif (!empty($qv['product_not_in'])) {
+			$product_not_in     = implode(',', wp_parse_id_list($qv['product_not_in']));
 			$this->query_where .= " AND $table.`product_id` NOT IN ($product_not_in)";
 		}
 
-		if ( ! empty( $qv['invoice_in'] ) ) {
-			$invoice_in         = implode( ',', wp_parse_id_list( $qv['invoice_in'] ) );
+		if (!empty($qv['invoice_in'])) {
+			$invoice_in         = implode(',', wp_parse_id_list($qv['invoice_in']));
 			$this->query_where .= " AND $table.`parent_payment_id` IN ($invoice_in)";
-		} elseif ( ! empty( $qv['invoice_not_in'] ) ) {
-			$invoice_not_in     = implode( ',', wp_parse_id_list( $qv['invoice_not_in'] ) );
+		} elseif (!empty($qv['invoice_not_in'])) {
+			$invoice_not_in     = implode(',', wp_parse_id_list($qv['invoice_not_in']));
 			$this->query_where .= " AND $table.`parent_payment_id` NOT IN ($invoice_not_in)";
 		}
 
-		if ( ! empty( $qv['include'] ) ) {
-			$include            = implode( ',', wp_parse_id_list( $qv['include'] ) );
+		if (!empty($qv['include'])) {
+			$include            = implode(',', wp_parse_id_list($qv['include']));
 			$this->query_where .= " AND $table.`id` IN ($include)";
-		} elseif ( ! empty( $qv['exclude'] ) ) {
-			$exclude            = implode( ',', wp_parse_id_list( $qv['exclude'] ) );
+		} elseif (!empty($qv['exclude'])) {
+			$exclude            = implode(',', wp_parse_id_list($qv['exclude']));
 			$this->query_where .= " AND $table.`id` NOT IN ($exclude)";
 		}
 
 		// Date queries are allowed for the subscription creation date.
-		if ( ! empty( $qv['date_created_query'] ) && is_array( $qv['date_created_query'] ) ) {
-			$date_created_query = new WP_Date_Query( $qv['date_created_query'], "$table.created" );
+		if (!empty($qv['date_created_query']) && is_array($qv['date_created_query'])) {
+			$date_created_query = new WP_Date_Query($qv['date_created_query'], "$table.created");
 			$this->query_where .= $date_created_query->get_sql();
 		}
 
 		// Date queries are also allowed for the subscription expiration date.
-		if ( ! empty( $qv['date_expires_query'] ) && is_array( $qv['date_expires_query'] ) ) {
-			$date_expires_query = new WP_Date_Query( $qv['date_expires_query'], "$table.expiration" );
+		if (!empty($qv['date_expires_query']) && is_array($qv['date_expires_query'])) {
+			$date_expires_query = new WP_Date_Query($qv['date_expires_query'], "$table.expiration");
 			$this->query_where .= $date_expires_query->get_sql();
 		}
 
@@ -325,24 +325,24 @@ 
 	 * @param array $qv Query vars.
 	 * @param string $table Table name.
 	 */
-	protected function prepare_query_order( &$qv, $table ) {
+	protected function prepare_query_order(&$qv, $table) {
 
 		// sorting.
-		$qv['order'] = isset( $qv['order'] ) ? strtoupper( $qv['order'] ) : '';
-		$order       = $this->parse_order( $qv['order'] );
+		$qv['order'] = isset($qv['order']) ? strtoupper($qv['order']) : '';
+		$order       = $this->parse_order($qv['order']);
 
 		// Default order is by 'id' (latest subscriptions).
-		if ( empty( $qv['orderby'] ) ) {
-			$qv['orderby'] = array( 'id' );
+		if (empty($qv['orderby'])) {
+			$qv['orderby'] = array('id');
 		}
 
 		// 'orderby' values may be an array, comma- or space-separated list.
-		$ordersby      = array_filter( wpinv_parse_list(  $qv['orderby'] ) );
+		$ordersby      = array_filter(wpinv_parse_list($qv['orderby']));
 
 		$orderby_array = array();
-		foreach ( $ordersby as $_key => $_value ) {
+		foreach ($ordersby as $_key => $_value) {
 
-			if ( is_int( $_key ) ) {
+			if (is_int($_key)) {
 				// Integer key means this is a flat array of 'orderby' fields.
 				$_orderby = $_value;
 				$_order   = $order;
@@ -352,20 +352,20 @@ 
 				$_order   = $_value;
 			}
 
-			$parsed = $this->parse_orderby( $_orderby, $table );
+			$parsed = $this->parse_orderby($_orderby, $table);
 
-			if ( $parsed ) {
-				$orderby_array[] = $parsed . ' ' . $this->parse_order( $_order );
+			if ($parsed) {
+				$orderby_array[] = $parsed . ' ' . $this->parse_order($_order);
 			}
 
 		}
 
 		// If no valid clauses were found, order by id.
-		if ( empty( $orderby_array ) ) {
+		if (empty($orderby_array)) {
 			$orderby_array[] = "id $order";
 		}
 
-		$this->query_orderby = 'ORDER BY ' . implode( ', ', $orderby_array );
+		$this->query_orderby = 'ORDER BY ' . implode(', ', $orderby_array);
 
 	}
 
@@ -379,34 +379,34 @@ 
 	public function query() {
 		global $wpdb;
 
-		$qv =& $this->query_vars;
+		$qv = & $this->query_vars;
 
 		// Return a non-null value to bypass the default GetPaid subscriptions query and remember to set the
 		// total_subscriptions property.
-		$this->results = apply_filters_ref_array( 'getpaid_subscriptions_pre_query', array( null, &$this ) );
+		$this->results = apply_filters_ref_array('getpaid_subscriptions_pre_query', array(null, &$this));
 
-		if ( null === $this->results ) {
+		if (null === $this->results) {
 			$this->request = "SELECT $this->query_fields $this->query_from $this->query_where $this->query_orderby $this->query_limit";
 
-			if ( ( is_array( $qv['fields'] ) && 1 != count( $qv['fields'] ) ) || 'all' == $qv['fields'] ) {
-				$this->results = $wpdb->get_results( $this->request );
+			if ((is_array($qv['fields']) && 1 != count($qv['fields'])) || 'all' == $qv['fields']) {
+				$this->results = $wpdb->get_results($this->request);
 			} else {
-				$this->results = $wpdb->get_col( $this->request );
+				$this->results = $wpdb->get_col($this->request);
 			}
 
-			if ( isset( $qv['count_total'] ) && $qv['count_total'] ) {
-				$found_subscriptions_query = apply_filters( 'getpaid_found_subscriptions_query', 'SELECT FOUND_ROWS()', $this );
-				$this->total_subscriptions   = (int) $wpdb->get_var( $found_subscriptions_query );
+			if (isset($qv['count_total']) && $qv['count_total']) {
+				$found_subscriptions_query = apply_filters('getpaid_found_subscriptions_query', 'SELECT FOUND_ROWS()', $this);
+				$this->total_subscriptions = (int) $wpdb->get_var($found_subscriptions_query);
 			}
 		}
 
-		if ( 'all' == $qv['fields'] ) {
-			foreach ( $this->results as $key => $subscription ) {
-				wp_cache_set( $subscription->id, $subscription, 'getpaid_subscriptions' );
-				wp_cache_set( $subscription->profile_id, $subscription->id, 'getpaid_subscription_profile_ids_to_subscription_ids' );
-				wp_cache_set( $subscription->transaction_id, $subscription->id, 'getpaid_subscription_transaction_ids_to_subscription_ids' );
-				wp_cache_set( $subscription->transaction_id, $subscription->id, 'getpaid_subscription_transaction_ids_to_subscription_ids' );
-				$this->results[ $key ] = new WPInv_Subscription( $subscription );
+		if ('all' == $qv['fields']) {
+			foreach ($this->results as $key => $subscription) {
+				wp_cache_set($subscription->id, $subscription, 'getpaid_subscriptions');
+				wp_cache_set($subscription->profile_id, $subscription->id, 'getpaid_subscription_profile_ids_to_subscription_ids');
+				wp_cache_set($subscription->transaction_id, $subscription->id, 'getpaid_subscription_transaction_ids_to_subscription_ids');
+				wp_cache_set($subscription->transaction_id, $subscription->id, 'getpaid_subscription_transaction_ids_to_subscription_ids');
+				$this->results[$key] = new WPInv_Subscription($subscription);
 			}
 		}
 
@@ -420,9 +420,9 @@ 
 	 * @param string $query_var Query variable key.
 	 * @return mixed
 	 */
-	public function get( $query_var ) {
-		if ( isset( $this->query_vars[ $query_var ] ) ) {
-			return $this->query_vars[ $query_var ];
+	public function get($query_var) {
+		if (isset($this->query_vars[$query_var])) {
+			return $this->query_vars[$query_var];
 		}
 
 		return null;
@@ -436,8 +436,8 @@ 
 	 * @param string $query_var Query variable key.
 	 * @param mixed $value Query variable value.
 	 */
-	public function set( $query_var, $value ) {
-		$this->query_vars[ $query_var ] = $value;
+	public function set($query_var, $value) {
+		$this->query_vars[$query_var] = $value;
 	}
 
 	/**
@@ -471,16 +471,16 @@ 
 	 *  @param string $table The current table.
 	 * @return string Value to use in the ORDER clause, if `$orderby` is valid.
 	 */
-	protected function parse_orderby( $orderby, $table ) {
+	protected function parse_orderby($orderby, $table) {
 
 		$_orderby = '';
-		if ( in_array( $orderby, array( 'customer_id', 'frequency', 'period', 'initial_amount', 'recurring_amount', 'bill_times', 'transaction_id', 'parent_payment_id', 'product_id', 'created', 'expiration', 'trial_period', 'status', 'profile_id' ) ) ) {
+		if (in_array($orderby, array('customer_id', 'frequency', 'period', 'initial_amount', 'recurring_amount', 'bill_times', 'transaction_id', 'parent_payment_id', 'product_id', 'created', 'expiration', 'trial_period', 'status', 'profile_id'))) {
 			$_orderby = "$table.`$orderby`";
-		} elseif ( 'id' === strtolower( $orderby ) ) {
+		} elseif ('id' === strtolower($orderby)) {
 			$_orderby = "$table.id";
-		} elseif ( 'include' === $orderby && ! empty( $this->query_vars['include'] ) ) {
-			$include     = wp_parse_id_list( $this->query_vars['include'] );
-			$include_sql = implode( ',', $include );
+		} elseif ('include' === $orderby && !empty($this->query_vars['include'])) {
+			$include     = wp_parse_id_list($this->query_vars['include']);
+			$include_sql = implode(',', $include);
 			$_orderby    = "FIELD( $table.id, $include_sql )";
 		}
 
@@ -495,12 +495,12 @@ 
 	 * @param string $order The 'order' query variable.
 	 * @return string The sanitized 'order' query variable.
 	 */
-	protected function parse_order( $order ) {
-		if ( ! is_string( $order ) || empty( $order ) ) {
+	protected function parse_order($order) {
+		if (!is_string($order) || empty($order)) {
 			return 'DESC';
 		}
 
-		if ( 'ASC' === strtoupper( $order ) ) {
+		if ('ASC' === strtoupper($order)) {
 			return 'ASC';
 		} else {
 			return 'DESC';

includes/wpinv-email-functions.php

Indentation +3 added lines, -3 removed lines

@@ -110,8 +110,8 @@ 
     $css = getpaid_get_email_css();
 
     // include css inliner
-	if ( ! class_exists( 'Emogrifier' ) ) {
-		include_once( WPINV_PLUGIN_DIR . 'includes/libraries/class-emogrifier.php' );
+    if ( ! class_exists( 'Emogrifier' ) ) {
+        include_once( WPINV_PLUGIN_DIR . 'includes/libraries/class-emogrifier.php' );
     }
 
     // Inline the css.
@@ -190,7 +190,7 @@ 
     $message = wpinv_email_style_body( $message );
     $to      = array_merge( wpinv_parse_list( $to ), wpinv_parse_list( $cc ) );
 
-	return $mailer->send(
+    return $mailer->send(
         $to,
         $subject,
         $message,

Spacing +126 added lines, -126 removed lines

@@ -6,7 +6,7 @@ 
  * Please use GetPaid_Notification_Email_Sender
  */
 
-defined( 'ABSPATH' ) || exit;
+defined('ABSPATH') || exit;
 
 /*
 |--------------------------------------------------------------------------
@@ -17,19 +17,19 @@ 
 /**
  * Generates the email header.
  */
-function wpinv_email_header( $email_heading ) {
-    wpinv_get_template( 'emails/wpinv-email-header.php', compact( 'email_heading' ) );
+function wpinv_email_header($email_heading) {
+    wpinv_get_template('emails/wpinv-email-header.php', compact('email_heading'));
 }
-add_action( 'wpinv_email_header', 'wpinv_email_header' );
+add_action('wpinv_email_header', 'wpinv_email_header');
 
 
 /**
  * Generates the email footer.
  */
 function wpinv_email_footer() {
-    wpinv_get_template( 'emails/wpinv-email-footer.php' );
+    wpinv_get_template('emails/wpinv-email-footer.php');
 }
-add_action( 'wpinv_email_footer', 'wpinv_email_footer' );
+add_action('wpinv_email_footer', 'wpinv_email_footer');
 
 
 /**
@@ -39,13 +39,13 @@ 
  * @param string $email_type
  * @param bool $sent_to_admin
  */
-function wpinv_email_invoice_details( $invoice,  $email_type, $sent_to_admin ) {
+function wpinv_email_invoice_details($invoice, $email_type, $sent_to_admin) {
 
-    $args = compact( 'invoice', 'email_type', 'sent_to_admin' );
-    wpinv_get_template( 'emails/invoice-details.php', $args );
+    $args = compact('invoice', 'email_type', 'sent_to_admin');
+    wpinv_get_template('emails/invoice-details.php', $args);
 
 }
-add_action( 'wpinv_email_invoice_details', 'wpinv_email_invoice_details', 10, 3 );
+add_action('wpinv_email_invoice_details', 'wpinv_email_invoice_details', 10, 3);
 
 /**
  * Display line items in emails.
@@ -54,17 +54,17 @@ 
  * @param string $email_type
  * @param bool $sent_to_admin
  */
-function wpinv_email_invoice_items( $invoice, $email_type, $sent_to_admin ) {
+function wpinv_email_invoice_items($invoice, $email_type, $sent_to_admin) {
 
     // Prepare line items.
-    $columns = getpaid_invoice_item_columns( $invoice );
-    $columns = apply_filters( 'getpaid_invoice_line_items_table_columns', $columns, $invoice );
+    $columns = getpaid_invoice_item_columns($invoice);
+    $columns = apply_filters('getpaid_invoice_line_items_table_columns', $columns, $invoice);
 
     // Load the template.
-    wpinv_get_template( 'emails/invoice-items.php', compact( 'invoice', 'columns', 'email_type', 'sent_to_admin' ) );
+    wpinv_get_template('emails/invoice-items.php', compact('invoice', 'columns', 'email_type', 'sent_to_admin'));
 
 }
-add_action( 'wpinv_email_invoice_items', 'wpinv_email_invoice_items', 10, 3 );
+add_action('wpinv_email_invoice_items', 'wpinv_email_invoice_items', 10, 3);
 
 
 /**
@@ -74,13 +74,13 @@ 
  * @param string $email_type
  * @param bool $sent_to_admin
  */
-function wpinv_email_billing_details( $invoice, $email_type, $sent_to_admin ) {
+function wpinv_email_billing_details($invoice, $email_type, $sent_to_admin) {
 
-    $args = compact( 'invoice', 'email_type', 'sent_to_admin' );
-    wpinv_get_template( 'emails/wpinv-email-billing-details.php', $args );
+    $args = compact('invoice', 'email_type', 'sent_to_admin');
+    wpinv_get_template('emails/wpinv-email-billing-details.php', $args);
 
 }
-add_action( 'wpinv_email_billing_details', 'wpinv_email_billing_details', 10, 3 );
+add_action('wpinv_email_billing_details', 'wpinv_email_billing_details', 10, 3);
 
 /**
  * Returns email css.
@@ -88,8 +88,8 @@ 
  */
 function getpaid_get_email_css() {
 
-    $css = wpinv_get_template_html( 'emails/wpinv-email-styles.php' );
-    return apply_filters( 'wpinv_email_styles', $css );
+    $css = wpinv_get_template_html('emails/wpinv-email-styles.php');
+    return apply_filters('wpinv_email_styles', $css);
 
 }
 
@@ -100,26 +100,26 @@ 
  * @return string
  * 
  */
-function wpinv_email_style_body( $content ) {
+function wpinv_email_style_body($content) {
 
-    if ( ! class_exists( 'DOMDocument' ) ) {
+    if (!class_exists('DOMDocument')) {
         return $content;
     }
 
     $css = getpaid_get_email_css();
 
     // include css inliner
-	if ( ! class_exists( 'Emogrifier' ) ) {
-		include_once( WPINV_PLUGIN_DIR . 'includes/libraries/class-emogrifier.php' );
+	if (!class_exists('Emogrifier')) {
+		include_once(WPINV_PLUGIN_DIR . 'includes/libraries/class-emogrifier.php');
     }
 
     // Inline the css.
     try {
-        $emogrifier = new Emogrifier( $content, $css );
+        $emogrifier = new Emogrifier($content, $css);
         $_content   = $emogrifier->emogrify();
         $content    = $_content;
-    } catch ( Exception $e ) {
-        wpinv_error_log( $e->getMessage(), 'emogrifier' );
+    } catch (Exception $e) {
+        wpinv_error_log($e->getMessage(), 'emogrifier');
     }
 
     return $content;
@@ -128,37 +128,37 @@ 
 
 // Backwards compatibility.
 function wpinv_init_transactional_emails() {
-    foreach ( apply_filters( 'wpinv_email_actions', array() ) as $action ) {
-        add_action( $action, 'wpinv_send_transactional_email', 10, 10 );
+    foreach (apply_filters('wpinv_email_actions', array()) as $action) {
+        add_action($action, 'wpinv_send_transactional_email', 10, 10);
     }
 }
-add_action( 'init', 'wpinv_init_transactional_emails' );
+add_action('init', 'wpinv_init_transactional_emails');
 
 function wpinv_send_transactional_email() {
     $args       = func_get_args();
     $function   = current_filter() . '_notification';
-    do_action_ref_array( $function, $args );
+    do_action_ref_array($function, $args);
 }
 
 function wpinv_mail_get_from_address() {
-    $from_address = apply_filters( 'wpinv_mail_from_address', wpinv_get_option( 'email_from', get_option( 'admin_email' ) ) );
-    return sanitize_email( $from_address );
+    $from_address = apply_filters('wpinv_mail_from_address', wpinv_get_option('email_from', get_option('admin_email')));
+    return sanitize_email($from_address);
 }
 
 function wpinv_mail_get_from_name() {
-    $from_name = apply_filters( 'wpinv_mail_from_name', wpinv_get_option( 'email_from_name', get_bloginfo( 'name', 'display' ) ) );
-    return wp_specialchars_decode( esc_html( $from_name ), ENT_QUOTES );
+    $from_name = apply_filters('wpinv_mail_from_name', wpinv_get_option('email_from_name', get_bloginfo('name', 'display')));
+    return wp_specialchars_decode(esc_html($from_name), ENT_QUOTES);
 }
 
-function wpinv_mail_admin_bcc_active( $mail_type = '' ) {
-    $active = apply_filters( 'wpinv_mail_admin_bcc_active', wpinv_get_option( 'email_' . $mail_type . '_admin_bcc' ) );
-    return ( $active ? true : false );
+function wpinv_mail_admin_bcc_active($mail_type = '') {
+    $active = apply_filters('wpinv_mail_admin_bcc_active', wpinv_get_option('email_' . $mail_type . '_admin_bcc'));
+    return ($active ? true : false);
 }
     
-function wpinv_mail_get_content_type(  $content_type = 'text/html', $email_type = 'html' ) {
-    $email_type = apply_filters( 'wpinv_mail_content_type', $email_type );
+function wpinv_mail_get_content_type($content_type = 'text/html', $email_type = 'html') {
+    $email_type = apply_filters('wpinv_mail_content_type', $email_type);
 
-    switch ( $email_type ) {
+    switch ($email_type) {
         case 'html' :
             $content_type = 'text/html';
             break;
@@ -183,11 +183,11 @@ 
  * @param array        $attachments Any files to attach to the email.
  * @param string|array $cc An email or array of extra emails to send a copy of the email to.
  */
-function wpinv_mail_send( $to, $subject, $message, $deprecated, $attachments = array(), $cc = array() ) {
+function wpinv_mail_send($to, $subject, $message, $deprecated, $attachments = array(), $cc = array()) {
 
     $mailer  = new GetPaid_Notification_Email_Sender();
-    $message = wpinv_email_style_body( $message );
-    $to      = array_merge( wpinv_parse_list( $to ), wpinv_parse_list( $cc ) );
+    $message = wpinv_email_style_body($message);
+    $to      = array_merge(wpinv_parse_list($to), wpinv_parse_list($cc));
 
 	return $mailer->send(
         $to,
@@ -204,7 +204,7 @@ 
  * @return array
  */
 function wpinv_get_emails() {
-    return apply_filters( 'wpinv_get_emails', wpinv_get_data( 'email-settings' ) );
+    return apply_filters('wpinv_get_emails', wpinv_get_data('email-settings'));
 }
 
 /**
@@ -213,172 +213,172 @@ 
  * @param array $settings
  * @return array
  */
-function wpinv_settings_emails( $settings = array() ) {
-    $settings = array_merge( $settings, wpinv_get_emails() );
-    return apply_filters( 'wpinv_settings_get_emails', $settings );
+function wpinv_settings_emails($settings = array()) {
+    $settings = array_merge($settings, wpinv_get_emails());
+    return apply_filters('wpinv_settings_get_emails', $settings);
 }
-add_filter( 'wpinv_settings_emails', 'wpinv_settings_emails', 10, 1 );
+add_filter('wpinv_settings_emails', 'wpinv_settings_emails', 10, 1);
 
 /**
  * Filter email section names.
  * 
  */
-function wpinv_settings_sections_emails( $settings ) {
-    foreach  ( wpinv_get_emails() as $key => $email) {
-        $settings[$key] = ! empty( $email['email_' . $key . '_header']['name'] ) ? strip_tags( $email['email_' . $key . '_header']['name'] ) : strip_tags( $key );
+function wpinv_settings_sections_emails($settings) {
+    foreach (wpinv_get_emails() as $key => $email) {
+        $settings[$key] = !empty($email['email_' . $key . '_header']['name']) ? strip_tags($email['email_' . $key . '_header']['name']) : strip_tags($key);
     }
 
     return $settings;    
 }
-add_filter( 'wpinv_settings_sections_emails', 'wpinv_settings_sections_emails', 10, 1 );
+add_filter('wpinv_settings_sections_emails', 'wpinv_settings_sections_emails', 10, 1);
 
-function wpinv_email_is_enabled( $email_type ) {
+function wpinv_email_is_enabled($email_type) {
     $emails = wpinv_get_emails();
-    $enabled = isset( $emails[$email_type] ) && wpinv_get_option( 'email_'. $email_type . '_active', 0 ) ? true : false;
+    $enabled = isset($emails[$email_type]) && wpinv_get_option('email_' . $email_type . '_active', 0) ? true : false;
 
-    return apply_filters( 'wpinv_email_is_enabled', $enabled, $email_type );
+    return apply_filters('wpinv_email_is_enabled', $enabled, $email_type);
 }
 
-function wpinv_email_get_recipient( $email_type = '', $invoice_id = 0, $invoice = array() ) {
-    switch ( $email_type ) {
+function wpinv_email_get_recipient($email_type = '', $invoice_id = 0, $invoice = array()) {
+    switch ($email_type) {
         case 'new_invoice':
         case 'cancelled_invoice':
         case 'failed_invoice':
             $recipient  = wpinv_get_admin_email();
         break;
         default:
-            $invoice    = !empty( $invoice ) && is_object( $invoice ) ? $invoice : ( $invoice_id > 0 ? wpinv_get_invoice( $invoice_id ) : NULL );
-            $recipient  = !empty( $invoice ) ? $invoice->get_email() : '';
+            $invoice    = !empty($invoice) && is_object($invoice) ? $invoice : ($invoice_id > 0 ? wpinv_get_invoice($invoice_id) : NULL);
+            $recipient  = !empty($invoice) ? $invoice->get_email() : '';
         break;
     }
 
-    return apply_filters( 'wpinv_email_recipient', $recipient, $email_type, $invoice_id, $invoice );
+    return apply_filters('wpinv_email_recipient', $recipient, $email_type, $invoice_id, $invoice);
 }
 
 /**
  * Returns invoice CC recipients
  */
-function wpinv_email_get_cc_recipients( $email_type = '', $invoice_id = 0, $invoice = array() ) {
-    switch ( $email_type ) {
+function wpinv_email_get_cc_recipients($email_type = '', $invoice_id = 0, $invoice = array()) {
+    switch ($email_type) {
         case 'new_invoice':
         case 'cancelled_invoice':
         case 'failed_invoice':
             return array();
         break;
         default:
-            $invoice    = !empty( $invoice ) && is_object( $invoice ) ? $invoice : ( $invoice_id > 0 ? wpinv_get_invoice( $invoice_id ) : NULL );
-            $recipient  = empty( $invoice ) ? '' : get_post_meta( $invoice->ID, 'wpinv_email_cc', true );
-            if ( empty( $recipient ) ) {
+            $invoice    = !empty($invoice) && is_object($invoice) ? $invoice : ($invoice_id > 0 ? wpinv_get_invoice($invoice_id) : NULL);
+            $recipient  = empty($invoice) ? '' : get_post_meta($invoice->ID, 'wpinv_email_cc', true);
+            if (empty($recipient)) {
                 return array();
             }
-            return  array_filter( array_map( 'trim', explode( ',', $recipient ) ) );
+            return  array_filter(array_map('trim', explode(',', $recipient)));
         break;
     }
 
 }
 
-function wpinv_email_get_subject( $email_type = '', $invoice_id = 0, $invoice = array() ) {
-    $subject    = wpinv_get_option( 'email_' . $email_type . '_subject' );
-    $subject    = __( $subject, 'invoicing' );
+function wpinv_email_get_subject($email_type = '', $invoice_id = 0, $invoice = array()) {
+    $subject    = wpinv_get_option('email_' . $email_type . '_subject');
+    $subject    = __($subject, 'invoicing');
 
-    $subject    = wpinv_email_format_text( $subject, $invoice );
+    $subject    = wpinv_email_format_text($subject, $invoice);
 
-    return apply_filters( 'wpinv_email_subject', $subject, $email_type, $invoice_id, $invoice );
+    return apply_filters('wpinv_email_subject', $subject, $email_type, $invoice_id, $invoice);
 }
 
-function wpinv_email_get_heading( $email_type = '', $invoice_id = 0, $invoice = array() ) {
-    $email_heading = wpinv_get_option( 'email_' . $email_type . '_heading' );
-    $email_heading = __( $email_heading, 'invoicing' );
+function wpinv_email_get_heading($email_type = '', $invoice_id = 0, $invoice = array()) {
+    $email_heading = wpinv_get_option('email_' . $email_type . '_heading');
+    $email_heading = __($email_heading, 'invoicing');
 
-    $email_heading = wpinv_email_format_text( $email_heading, $invoice );
+    $email_heading = wpinv_email_format_text($email_heading, $invoice);
 
-    return apply_filters( 'wpinv_email_heading', $email_heading, $email_type, $invoice_id, $invoice );
+    return apply_filters('wpinv_email_heading', $email_heading, $email_type, $invoice_id, $invoice);
 }
 
-function wpinv_email_get_content( $email_type = '', $invoice_id = 0, $invoice = array() ) {
-    $content    = wpinv_get_option( 'email_' . $email_type . '_body' );
-    $content    = __( $content, 'invoicing' );
+function wpinv_email_get_content($email_type = '', $invoice_id = 0, $invoice = array()) {
+    $content    = wpinv_get_option('email_' . $email_type . '_body');
+    $content    = __($content, 'invoicing');
 
-    $content    = wpinv_email_format_text( $content, $invoice );
+    $content    = wpinv_email_format_text($content, $invoice);
 
-    return apply_filters( 'wpinv_email_content', $content, $email_type, $invoice_id, $invoice );
+    return apply_filters('wpinv_email_content', $content, $email_type, $invoice_id, $invoice);
 }
 
-function wpinv_email_get_headers( $email_type = '', $invoice_id = 0, $invoice = array() ) {
+function wpinv_email_get_headers($email_type = '', $invoice_id = 0, $invoice = array()) {
     $from_name = wpinv_mail_get_from_address();
     $from_email = wpinv_mail_get_from_address();
     
-    $invoice    = !empty( $invoice ) && is_object( $invoice ) ? $invoice : ( $invoice_id > 0 ? wpinv_get_invoice( $invoice_id ) : NULL );
+    $invoice    = !empty($invoice) && is_object($invoice) ? $invoice : ($invoice_id > 0 ? wpinv_get_invoice($invoice_id) : NULL);
     
-    $headers    = "From: " . stripslashes_deep( html_entity_decode( $from_name, ENT_COMPAT, 'UTF-8' ) ) . " <$from_email>\r\n";
-    $headers    .= "Reply-To: ". $from_email . "\r\n";
+    $headers    = "From: " . stripslashes_deep(html_entity_decode($from_name, ENT_COMPAT, 'UTF-8')) . " <$from_email>\r\n";
+    $headers    .= "Reply-To: " . $from_email . "\r\n";
     $headers    .= "Content-Type: " . wpinv_mail_get_content_type() . "\r\n";
     
-    return apply_filters( 'wpinv_email_headers', $headers, $email_type, $invoice_id, $invoice );
+    return apply_filters('wpinv_email_headers', $headers, $email_type, $invoice_id, $invoice);
 }
 
-function wpinv_email_get_attachments( $email_type = '', $invoice_id = 0, $invoice = array() ) {
+function wpinv_email_get_attachments($email_type = '', $invoice_id = 0, $invoice = array()) {
     $attachments = array();
     
-    return apply_filters( 'wpinv_email_attachments', $attachments, $email_type, $invoice_id, $invoice );
+    return apply_filters('wpinv_email_attachments', $attachments, $email_type, $invoice_id, $invoice);
 }
 
 /**
  * Searches for and replaces certain placeholders in an email.
  */
-function wpinv_email_format_text( $content, $invoice ) {
+function wpinv_email_format_text($content, $invoice) {
 
     $replace_array = array(
         '{site_title}'      => wpinv_get_blogname(),
-        '{date}'            => getpaid_format_date( current_time( 'mysql' ) ),
+        '{date}'            => getpaid_format_date(current_time('mysql')),
     );
 
-    $invoice = new WPInv_Invoice( $invoice );
+    $invoice = new WPInv_Invoice($invoice);
 
-    if ( $invoice->get_id() ) {
+    if ($invoice->get_id()) {
 
         $replace_array = array_merge(
             $replace_array, 
             array(
-                '{name}'            => sanitize_text_field( $invoice->get_user_full_name() ),
-                '{full_name}'       => sanitize_text_field( $invoice->get_user_full_name() ),
-                '{first_name}'      => sanitize_text_field( $invoice->get_first_name() ),
-                '{last_name}'       => sanitize_text_field( $invoice->get_last_name() ),
-                '{email}'           => sanitize_email( $invoice->get_email() ),
-                '{invoice_number}'  => sanitize_text_field( $invoice->get_number() ),
-                '{invoice_total}'   => sanitize_text_field( wpinv_price( $invoice->get_total( true ), $invoice->get_currency() ) ),
-                '{invoice_link}'    => esc_url( $invoice->get_view_url() ),
-                '{invoice_pay_link}'=> esc_url( $invoice->get_checkout_payment_url() ),
-                '{invoice_date}'    => date( get_option( 'date_format' ), strtotime( $invoice->get_date_created(), current_time( 'timestamp' ) ) ),
-                '{invoice_due_date}'=> date( get_option( 'date_format' ), strtotime( $invoice->get_due_date(), current_time( 'timestamp' ) ) ),
-                '{invoice_quote}'   => sanitize_text_field( $invoice->get_invoice_quote_type() ),
-                '{invoice_label}'   => sanitize_text_field( ucfirst( $invoice->get_invoice_quote_type() ) ),
-                '{is_was}'          => strtotime( $invoice->get_due_date() ) < current_time( 'timestamp' ) ? __( 'was', 'invoicing' ) : __( 'is', 'invoicing' ),
+                '{name}'            => sanitize_text_field($invoice->get_user_full_name()),
+                '{full_name}'       => sanitize_text_field($invoice->get_user_full_name()),
+                '{first_name}'      => sanitize_text_field($invoice->get_first_name()),
+                '{last_name}'       => sanitize_text_field($invoice->get_last_name()),
+                '{email}'           => sanitize_email($invoice->get_email()),
+                '{invoice_number}'  => sanitize_text_field($invoice->get_number()),
+                '{invoice_total}'   => sanitize_text_field(wpinv_price($invoice->get_total(true), $invoice->get_currency())),
+                '{invoice_link}'    => esc_url($invoice->get_view_url()),
+                '{invoice_pay_link}'=> esc_url($invoice->get_checkout_payment_url()),
+                '{invoice_date}'    => date(get_option('date_format'), strtotime($invoice->get_date_created(), current_time('timestamp'))),
+                '{invoice_due_date}'=> date(get_option('date_format'), strtotime($invoice->get_due_date(), current_time('timestamp'))),
+                '{invoice_quote}'   => sanitize_text_field($invoice->get_invoice_quote_type()),
+                '{invoice_label}'   => sanitize_text_field(ucfirst($invoice->get_invoice_quote_type())),
+                '{is_was}'          => strtotime($invoice->get_due_date()) < current_time('timestamp') ? __('was', 'invoicing') : __('is', 'invoicing'),
             )
         );
 
     }
 
     // Let third party plugins filter the arra.
-    $replace_array = apply_filters( 'wpinv_email_format_text', $replace_array, $content, $invoice );
+    $replace_array = apply_filters('wpinv_email_format_text', $replace_array, $content, $invoice);
 
-    foreach ( $replace_array as $key => $value ) {
-        $content = str_replace( $key, $value, $content );
+    foreach ($replace_array as $key => $value) {
+        $content = str_replace($key, $value, $content);
     }
 
-    return apply_filters( 'wpinv_email_content_replace', $content );
+    return apply_filters('wpinv_email_content_replace', $content);
 }
 
 
-function wpinv_email_wrap_message( $message ) {
+function wpinv_email_wrap_message($message) {
     // Buffer
     ob_start();
 
-    do_action( 'wpinv_email_header' );
+    do_action('wpinv_email_header');
 
-    echo wp_kses_post( wpautop( wptexturize( $message ) ) );
+    echo wp_kses_post(wpautop(wptexturize($message)));
 
-    do_action( 'wpinv_email_footer' );
+    do_action('wpinv_email_footer');
 
     // Get contents
     $message = ob_get_clean();
@@ -386,21 +386,21 @@ 
     return $message;
 }
 
-function wpinv_add_notes_to_invoice_email( $invoice, $email_type ) {
-    if ( !empty( $invoice ) && $email_type == 'user_invoice' && $invoice_notes = wpinv_get_invoice_notes( $invoice->get_id(), true ) ) {
-        $date_format = get_option( 'date_format' );
-        $time_format = get_option( 'time_format' );
+function wpinv_add_notes_to_invoice_email($invoice, $email_type) {
+    if (!empty($invoice) && $email_type == 'user_invoice' && $invoice_notes = wpinv_get_invoice_notes($invoice->get_id(), true)) {
+        $date_format = get_option('date_format');
+        $time_format = get_option('time_format');
         ?>
         <div id="wpinv-email-notes">
-            <h3 class="wpinv-notes-t"><?php echo apply_filters( 'wpinv_email_invoice_notes_title', __( 'Invoice Notes', 'invoicing' ) ); ?></h3>
+            <h3 class="wpinv-notes-t"><?php echo apply_filters('wpinv_email_invoice_notes_title', __('Invoice Notes', 'invoicing')); ?></h3>
             <ol class="wpinv-notes-lists">
         <?php
-        foreach ( $invoice_notes as $note ) {
-            $note_time = strtotime( $note->comment_date );
+        foreach ($invoice_notes as $note) {
+            $note_time = strtotime($note->comment_date);
             ?>
             <li class="comment wpinv-note">
-            <p class="wpinv-note-date meta"><?php printf( __( '%2$s at %3$s', 'invoicing' ), $note->comment_author, date_i18n( $date_format, $note_time ), date_i18n( $time_format, $note_time ), $note_time ); ?></p>
-            <div class="wpinv-note-desc description"><?php echo wp_kses_post( wpautop( wptexturize( $note->comment_content ) ) ); ?></div>
+            <p class="wpinv-note-date meta"><?php printf(__('%2$s at %3$s', 'invoicing'), $note->comment_author, date_i18n($date_format, $note_time), date_i18n($time_format, $note_time), $note_time); ?></p>
+            <div class="wpinv-note-desc description"><?php echo wp_kses_post(wpautop(wptexturize($note->comment_content))); ?></div>
             </li>
             <?php
         }
@@ -409,4 +409,4 @@ 
         <?php
     }
 }
-add_action( 'wpinv_email_billing_details', 'wpinv_add_notes_to_invoice_email', 10, 3 );
+add_action('wpinv_email_billing_details', 'wpinv_add_notes_to_invoice_email', 10, 3);