AyeCode / invoicing

templates/emails/wpinv-email-completed_invoice.php

Spacing +6 added lines, -6 removed lines

@@ -7,22 +7,22 @@
  * @version 1.0.19
  */
 
-defined( 'ABSPATH' ) || exit;
+defined('ABSPATH') || exit;
 
 // Print the email header.
-do_action( 'wpinv_email_header', $email_heading, $invoice, $email_type, $sent_to_admin );
+do_action('wpinv_email_header', $email_heading, $invoice, $email_type, $sent_to_admin);
 
 // Generate the custom message body.
 echo $message_body;
 
 // Print invoice details.
-do_action( 'wpinv_email_invoice_details', $invoice, $email_type, $sent_to_admin );
+do_action('wpinv_email_invoice_details', $invoice, $email_type, $sent_to_admin);
 
 // Print invoice items.
-do_action( 'wpinv_email_invoice_items', $invoice, $email_type, $sent_to_admin );
+do_action('wpinv_email_invoice_items', $invoice, $email_type, $sent_to_admin);
 
 // Print the billing details.
-do_action( 'wpinv_email_billing_details', $invoice, $email_type, $sent_to_admin );
+do_action('wpinv_email_billing_details', $invoice, $email_type, $sent_to_admin);
 
 // Print the email footer.
-do_action( 'wpinv_email_footer', $invoice, $email_type, $sent_to_admin );
+do_action('wpinv_email_footer', $invoice, $email_type, $sent_to_admin);

templates/emails/wpinv-email-user_invoice.php

Spacing +6 added lines, -6 removed lines

@@ -7,22 +7,22 @@
  * @version 1.0.19
  */
 
-defined( 'ABSPATH' ) || exit;
+defined('ABSPATH') || exit;
 
 // Print the email header.
-do_action( 'wpinv_email_header', $email_heading, $invoice, $email_type, $sent_to_admin );
+do_action('wpinv_email_header', $email_heading, $invoice, $email_type, $sent_to_admin);
 
 // Generate the custom message body.
 echo $message_body;
 
 // Print invoice details.
-do_action( 'wpinv_email_invoice_details', $invoice, $email_type, $sent_to_admin );
+do_action('wpinv_email_invoice_details', $invoice, $email_type, $sent_to_admin);
 
 // Print invoice items.
-do_action( 'wpinv_email_invoice_items', $invoice, $email_type, $sent_to_admin );
+do_action('wpinv_email_invoice_items', $invoice, $email_type, $sent_to_admin);
 
 // Print the billing details.
-do_action( 'wpinv_email_billing_details', $invoice, $email_type, $sent_to_admin );
+do_action('wpinv_email_billing_details', $invoice, $email_type, $sent_to_admin);
 
 // Print the email footer.
-do_action( 'wpinv_email_footer', $invoice, $email_type, $sent_to_admin );
+do_action('wpinv_email_footer', $invoice, $email_type, $sent_to_admin);

templates/emails/wpinv-email-cancelled_invoice.php

Spacing +6 added lines, -6 removed lines

@@ -7,22 +7,22 @@
  * @version 1.0.19
  */
 
-defined( 'ABSPATH' ) || exit;
+defined('ABSPATH') || exit;
 
 // Print the email header.
-do_action( 'wpinv_email_header', $email_heading, $invoice, $email_type, $sent_to_admin );
+do_action('wpinv_email_header', $email_heading, $invoice, $email_type, $sent_to_admin);
 
 // Generate the custom message body.
 echo $message_body;
 
 // Print invoice details.
-do_action( 'wpinv_email_invoice_details', $invoice, $email_type, $sent_to_admin );
+do_action('wpinv_email_invoice_details', $invoice, $email_type, $sent_to_admin);
 
 // Print invoice items.
-do_action( 'wpinv_email_invoice_items', $invoice, $email_type, $sent_to_admin );
+do_action('wpinv_email_invoice_items', $invoice, $email_type, $sent_to_admin);
 
 // Print the billing details.
-do_action( 'wpinv_email_billing_details', $invoice, $email_type, $sent_to_admin );
+do_action('wpinv_email_billing_details', $invoice, $email_type, $sent_to_admin);
 
 // Print the email footer.
-do_action( 'wpinv_email_footer', $invoice, $email_type, $sent_to_admin );
+do_action('wpinv_email_footer', $invoice, $email_type, $sent_to_admin);

templates/emails/wpinv-email-refunded_invoice.php

Spacing +6 added lines, -6 removed lines

@@ -7,22 +7,22 @@
  * @version 1.0.19
  */
 
-defined( 'ABSPATH' ) || exit;
+defined('ABSPATH') || exit;
 
 // Print the email header.
-do_action( 'wpinv_email_header', $email_heading, $invoice, $email_type, $sent_to_admin );
+do_action('wpinv_email_header', $email_heading, $invoice, $email_type, $sent_to_admin);
 
 // Generate the custom message body.
 echo $message_body;
 
 // Print invoice details.
-do_action( 'wpinv_email_invoice_details', $invoice, $email_type, $sent_to_admin );
+do_action('wpinv_email_invoice_details', $invoice, $email_type, $sent_to_admin);
 
 // Print invoice items.
-do_action( 'wpinv_email_invoice_items', $invoice, $email_type, $sent_to_admin );
+do_action('wpinv_email_invoice_items', $invoice, $email_type, $sent_to_admin);
 
 // Print the billing details.
-do_action( 'wpinv_email_billing_details', $invoice, $email_type, $sent_to_admin );
+do_action('wpinv_email_billing_details', $invoice, $email_type, $sent_to_admin);
 
 // Print the email footer.
-do_action( 'wpinv_email_footer', $invoice, $email_type, $sent_to_admin );
+do_action('wpinv_email_footer', $invoice, $email_type, $sent_to_admin);

templates/emails/wpinv-email-failed_invoice.php

Spacing +6 added lines, -6 removed lines

@@ -7,22 +7,22 @@
  * @version 1.0.19
  */
 
-defined( 'ABSPATH' ) || exit;
+defined('ABSPATH') || exit;
 
 // Print the email header.
-do_action( 'wpinv_email_header', $email_heading, $invoice, $email_type, $sent_to_admin );
+do_action('wpinv_email_header', $email_heading, $invoice, $email_type, $sent_to_admin);
 
 // Generate the custom message body.
 echo $message_body;
 
 // Print invoice details.
-do_action( 'wpinv_email_invoice_details', $invoice, $email_type, $sent_to_admin );
+do_action('wpinv_email_invoice_details', $invoice, $email_type, $sent_to_admin);
 
 // Print invoice items.
-do_action( 'wpinv_email_invoice_items', $invoice, $email_type, $sent_to_admin );
+do_action('wpinv_email_invoice_items', $invoice, $email_type, $sent_to_admin);
 
 // Print the billing details.
-do_action( 'wpinv_email_billing_details', $invoice, $email_type, $sent_to_admin );
+do_action('wpinv_email_billing_details', $invoice, $email_type, $sent_to_admin);
 
 // Print the email footer.
-do_action( 'wpinv_email_footer', $invoice, $email_type, $sent_to_admin );
+do_action('wpinv_email_footer', $invoice, $email_type, $sent_to_admin);

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/admin/meta-boxes/class-getpaid-meta-box-invoice-subscription.php

Indentation +9 added lines, -9 removed lines

@@ -6,7 +6,7 @@ 
  */
 
 if ( ! defined( 'ABSPATH' ) ) {
-	exit; // Exit if accessed directly
+    exit; // Exit if accessed directly
 }
 
 /**
@@ -15,10 +15,10 @@ 
 class GetPaid_Meta_Box_Invoice_Subscription {
 
     /**
-	 * Output the subscription metabox.
-	 *
-	 * @param WP_Post $post
-	 */
+     * Output the subscription metabox.
+     *
+     * @param WP_Post $post
+     */
     public static function output( $post ) {
 
         // Fetch the invoice.
@@ -34,10 +34,10 @@ 
     }
 
     /**
-	 * Output the subscription invoices.
-	 *
-	 * @param WP_Post $post
-	 */
+     * Output the subscription invoices.
+     *
+     * @param WP_Post $post
+     */
     public static function output_invoices( $post ) {
 
         // Fetch the invoice.

Spacing +9 added lines, -9 removed lines

@@ -5,7 +5,7 @@ 
  *
  */
 
-if ( ! defined( 'ABSPATH' ) ) {
+if (!defined('ABSPATH')) {
 	exit; // Exit if accessed directly
 }
 
@@ -19,16 +19,16 @@ 
 	 *
 	 * @param WP_Post $post
 	 */
-    public static function output( $post ) {
+    public static function output($post) {
 
         // Fetch the invoice.
-        $invoice = new WPInv_Invoice( $post );
+        $invoice = new WPInv_Invoice($post);
 
         // Fetch the subscription.
-        $subscription = getpaid_get_invoice_subscription( $invoice );
+        $subscription = getpaid_get_invoice_subscription($invoice);
 
         echo '<div class="bsui">';
-        getpaid_admin_subscription_details_metabox( /** @scrutinizer ignore-type */$subscription );
+        getpaid_admin_subscription_details_metabox(/** @scrutinizer ignore-type */$subscription);
         echo '</div>';
 
     }
@@ -38,16 +38,16 @@ 
 	 *
 	 * @param WP_Post $post
 	 */
-    public static function output_invoices( $post ) {
+    public static function output_invoices($post) {
 
         // Fetch the invoice.
-        $invoice = new WPInv_Invoice( $post );
+        $invoice = new WPInv_Invoice($post);
 
         // Fetch the subscription.
-        $subscription = getpaid_get_invoice_subscription( $invoice );
+        $subscription = getpaid_get_invoice_subscription($invoice);
 
         echo '<div class="bsui">';
-        getpaid_admin_subscription_invoice_details_metabox( /** @scrutinizer ignore-type */$subscription );
+        getpaid_admin_subscription_invoice_details_metabox(/** @scrutinizer ignore-type */$subscription);
         echo '</div>';
 
     }

vendor/ayecode/wp-ayecode-ui/includes/components/class-aui-component-helper.php

Braces +1 added lines, -1 removed lines

@@ -207,7 +207,7 @@
 				foreach($args as $key => $val){
 					$output .= ' '.sanitize_html_class($key).'="'.esc_attr($val).'" ';
 				}
-			}else{
+			} else{
 				$output .= ' '.$args.' ';
 			}
 

Indentation +369 added lines, -369 removed lines

@@ -1,7 +1,7 @@ 
 <?php
 
 if ( ! defined( 'ABSPATH' ) ) {
-	exit; // Exit if accessed directly
+    exit; // Exit if accessed directly
 }
 
 /**
@@ -11,372 +11,372 @@ 
  */
 class AUI_Component_Helper {
 
-	/**
-	 * A component helper for generating a input name.
-	 *
-	 * @param $text
-	 * @param $multiple bool If the name is set to be multiple but no brackets found then we add some.
-	 *
-	 * @return string
-	 */
-	public static function name($text,$multiple = false){
-		$output = '';
-
-		if($text){
-			$is_multiple = strpos($text, '[') === false && $multiple  ? '[]' : '';
-			$output = ' name="'.esc_attr($text).$is_multiple.'" ';
-		}
-
-		return $output;
-	}
-
-	/**
-	 * A component helper for generating a item id.
-	 *
-	 * @param $text string The text to be used as the value.
-	 *
-	 * @return string The sanitized item.
-	 */
-	public static function id($text){
-		$output = '';
-
-		if($text){
-			$output = ' id="'.sanitize_html_class($text).'" ';
-		}
-
-		return $output;
-	}
-
-	/**
-	 * A component helper for generating a item title.
-	 *
-	 * @param $text string The text to be used as the value.
-	 *
-	 * @return string The sanitized item.
-	 */
-	public static function title($text){
-		$output = '';
-
-		if($text){
-			$output = ' title="'.esc_attr($text).'" ';
-		}
-
-		return $output;
-	}
-
-	/**
-	 * A component helper for generating a item value.
-	 *
-	 * @param $text string The text to be used as the value.
-	 *
-	 * @return string The sanitized item.
-	 */
-	public static function value($text){
-		$output = '';
-
-		if($text){
-			$output = ' value="'.sanitize_text_field($text).'" ';
-		}
-
-		return $output;
-	}
-
-	/**
-	 * A component helper for generating a item class attribute.
-	 *
-	 * @param $text string The text to be used as the value.
-	 *
-	 * @return string The sanitized item.
-	 */
-	public static function class_attr($text){
-		$output = '';
-
-		if($text){
-			$classes = self::esc_classes($text);
-			if(!empty($classes)){
-				$output = ' class="'.$classes.'" ';
-			}
-		}
-
-		return $output;
-	}
-
-	/**
-	 * Escape a string of classes.
-	 *
-	 * @param $text
-	 *
-	 * @return string
-	 */
-	public static function esc_classes($text){
-		$output = '';
-
-		if($text){
-			$classes = explode(" ",$text);
-			$classes = array_map("trim",$classes);
-			$classes = array_map("sanitize_html_class",$classes);
-			if(!empty($classes)){
-				$output = implode(" ",$classes);
-			}
-		}
-
-		return $output;
-
-	}
-
-	/**
-	 * @param $args
-	 *
-	 * @return string
-	 */
-	public static function data_attributes($args){
-		$output = '';
-
-		if(!empty($args)){
-
-			foreach($args as $key => $val){
-				if(substr( $key, 0, 5 ) === "data-"){
-					$output .= ' '.sanitize_html_class($key).'="'.esc_attr($val).'" ';
-				}
-			}
-		}
-
-		return $output;
-	}
-
-	/**
-	 * @param $args
-	 *
-	 * @return string
-	 */
-	public static function aria_attributes($args){
-		$output = '';
-
-		if(!empty($args)){
-
-			foreach($args as $key => $val){
-				if(substr( $key, 0, 5 ) === "aria-"){
-					$output .= ' '.sanitize_html_class($key).'="'.esc_attr($val).'" ';
-				}
-			}
-		}
-
-		return $output;
-	}
-
-	/**
-	 * Build a font awesome icon from a class.
-	 *
-	 * @param $class
-	 * @param bool $space_after
-	 * @param array $extra_attributes An array of extra attributes.
-	 *
-	 * @return string
-	 */
-	public static function icon($class,$space_after = false, $extra_attributes = array()){
-		$output = '';
-
-		if($class){
-			$classes = self::esc_classes($class);
-			if(!empty($classes)){
-				$output = '<i class="'.$classes.'" ';
-				// extra attributes
-				if(!empty($extra_attributes)){
-					$output .= AUI_Component_Helper::extra_attributes($extra_attributes);
-				}
-				$output .= '></i>';
-				if($space_after){
-					$output .= " ";
-				}
-			}
-		}
-
-		return $output;
-	}
-
-	/**
-	 * @param $args
-	 *
-	 * @return string
-	 */
-	public static function extra_attributes($args){
-		$output = '';
-
-		if(!empty($args)){
-
-			if( is_array($args) ){
-				foreach($args as $key => $val){
-					$output .= ' '.sanitize_html_class($key).'="'.esc_attr($val).'" ';
-				}
-			}else{
-				$output .= ' '.$args.' ';
-			}
-
-		}
-
-		return $output;
-	}
-
-	/**
-	 * @param $args
-	 *
-	 * @return string
-	 */
-	public static function help_text($text){
-		$output = '';
-
-		if($text){
-			$output .= '<small class="form-text text-muted">'.wp_kses_post($text).'</small>';
-		}
-
-
-		return $output;
-	}
-
-	/**
-	 * Replace element require context with JS.
-	 *
-	 * @param $input
-	 *
-	 * @return string|void
-	 */
-	public static function element_require( $input ) {
-
-		$input = str_replace( "'", '"', $input );// we only want double quotes
-
-		$output = esc_attr( str_replace( array( "[%", "%]", "%:checked]" ), array(
-			"jQuery(form).find('[data-argument=\"",
-			"\"]').find('input,select,textarea').val()",
-			"\"]').find('input:checked').val()",
-		), $input ) );
-
-		if($output){
-			$output = ' data-element-require="'.$output.'" ';
-		}
-
-		return $output;
-	}
-
-	/**
-	 * Returns an array of allowed HTML tags and attributes for a given context.
-	 *
-	 * @since 0.1.41
-	 *
-	 * @param string|array $context The context for which to retrieve tags. Allowed values are 'post',
-	 *                              'strip', 'data', 'entities', or the name of a field filter such as
-	 *                              'pre_user_description'.
-	 * @param array $input Input.
-	 * @return array Array of allowed HTML tags and their allowed attributes.
-	 */
-	public static function kses_allowed_html( $context = 'post', $input = array() ) {
-		$allowed_html = wp_kses_allowed_html( $context );
-
-		if ( is_array( $allowed_html ) ) {
-			// <iframe>
-			if ( ! isset( $allowed_html['iframe'] ) && $context == 'post' ) {
-				$allowed_html['iframe']     = array(
-					'class'        => true,
-					'id'           => true,
-					'src'          => true,
-					'width'        => true,
-					'height'       => true,
-					'frameborder'  => true,
-					'marginwidth'  => true,
-					'marginheight' => true,
-					'scrolling'    => true,
-					'style'        => true,
-					'title'        => true,
-					'allow'        => true,
-					'allowfullscreen' => true,
-					'data-*'       => true,
-				);
-			}
-		}
-
-		/**
-		 * Filters the allowed html tags.
-		 *
-		 * @since 0.1.41
-		 *
-		 * @param array[]|string $allowed_html Allowed html tags.
-		 * @param @param string|array $context The context for which to retrieve tags.
-		 * @param array $input Input field.
-		 */
-		return apply_filters( 'ayecode_ui_kses_allowed_html', $allowed_html, $context, $input );
-	}
-
-	/**
-	 * Filters content and keeps only allowable HTML elements.
-	 *
-	 * This function makes sure that only the allowed HTML element names, attribute
-	 * names and attribute values plus only sane HTML entities will occur in
-	 * $string. You have to remove any slashes from PHP's magic quotes before you
-	 * call this function.
-	 *
-	 * The default allowed protocols are 'http', 'https', 'ftp', 'mailto', 'news',
-	 * 'irc', 'gopher', 'nntp', 'feed', 'telnet, 'mms', 'rtsp' and 'svn'. This
-	 * covers all common link protocols, except for 'javascript' which should not
-	 * be allowed for untrusted users.
-	 *
-	 * @since 0.1.41
-	 *
-	 * @param string|array $value Content to filter through kses.
-	 * @param array  $input       Input Field.
-	 * @return string Filtered content with only allowed HTML elements.
-	 */
-	public static function _sanitize_html_field( $value, $input = array() ) {
-		if ( $value === '' ) {
-			return $value;
-		}
-
-		$allowed_html = self::kses_allowed_html( 'post', $input );
-
-		if ( ! is_array( $allowed_html ) ) {
-			$allowed_html = wp_kses_allowed_html( 'post' );
-		}
-
-		$filtered = trim( wp_unslash( $value ) );
-		$filtered = wp_kses( $filtered, $allowed_html );
-		$filtered = balanceTags( $filtered ); // Balances tags
-
-		return $filtered;
-	}
-
-	/**
-	 * Navigates through an array, object, or scalar, and removes slashes from the values.
-	 *
-	 * @since 0.1.41
-	 *
-	 * @param mixed $value The value to be stripped.
-	 * @param array  $input Input Field.
-	 * @return mixed Stripped value.
-	 */
-	public static function sanitize_html_field( $value, $input = array() ) {
-		$original = $value;
-
-		if ( is_array( $value ) ) {
-			foreach ( $value as $index => $item ) {
-				$value[ $index ] = self::_sanitize_html_field( $value, $input );
-			}
-		} elseif ( is_object( $value ) ) {
-			$object_vars = get_object_vars( $value );
-
-			foreach ( $object_vars as $property_name => $property_value ) {
-				$value->$property_name = self::_sanitize_html_field( $property_value, $input );
-			}
-		} else {
-			$value = self::_sanitize_html_field( $value, $input );
-		}
-
-		/**
-		 * Filters content and keeps only allowable HTML elements.
-		 *
-		 * @since 0.1.41
-		 *
-		 * @param string|array $value Content to filter through kses.
-		 * @param string|array $value Original content without filter.
-		 * @param array  $input       Input Field.
-		 */
-		return apply_filters( 'ayecode_ui_sanitize_html_field', $value, $original, $input );
-	}
+    /**
+     * A component helper for generating a input name.
+     *
+     * @param $text
+     * @param $multiple bool If the name is set to be multiple but no brackets found then we add some.
+     *
+     * @return string
+     */
+    public static function name($text,$multiple = false){
+        $output = '';
+
+        if($text){
+            $is_multiple = strpos($text, '[') === false && $multiple  ? '[]' : '';
+            $output = ' name="'.esc_attr($text).$is_multiple.'" ';
+        }
+
+        return $output;
+    }
+
+    /**
+     * A component helper for generating a item id.
+     *
+     * @param $text string The text to be used as the value.
+     *
+     * @return string The sanitized item.
+     */
+    public static function id($text){
+        $output = '';
+
+        if($text){
+            $output = ' id="'.sanitize_html_class($text).'" ';
+        }
+
+        return $output;
+    }
+
+    /**
+     * A component helper for generating a item title.
+     *
+     * @param $text string The text to be used as the value.
+     *
+     * @return string The sanitized item.
+     */
+    public static function title($text){
+        $output = '';
+
+        if($text){
+            $output = ' title="'.esc_attr($text).'" ';
+        }
+
+        return $output;
+    }
+
+    /**
+     * A component helper for generating a item value.
+     *
+     * @param $text string The text to be used as the value.
+     *
+     * @return string The sanitized item.
+     */
+    public static function value($text){
+        $output = '';
+
+        if($text){
+            $output = ' value="'.sanitize_text_field($text).'" ';
+        }
+
+        return $output;
+    }
+
+    /**
+     * A component helper for generating a item class attribute.
+     *
+     * @param $text string The text to be used as the value.
+     *
+     * @return string The sanitized item.
+     */
+    public static function class_attr($text){
+        $output = '';
+
+        if($text){
+            $classes = self::esc_classes($text);
+            if(!empty($classes)){
+                $output = ' class="'.$classes.'" ';
+            }
+        }
+
+        return $output;
+    }
+
+    /**
+     * Escape a string of classes.
+     *
+     * @param $text
+     *
+     * @return string
+     */
+    public static function esc_classes($text){
+        $output = '';
+
+        if($text){
+            $classes = explode(" ",$text);
+            $classes = array_map("trim",$classes);
+            $classes = array_map("sanitize_html_class",$classes);
+            if(!empty($classes)){
+                $output = implode(" ",$classes);
+            }
+        }
+
+        return $output;
+
+    }
+
+    /**
+     * @param $args
+     *
+     * @return string
+     */
+    public static function data_attributes($args){
+        $output = '';
+
+        if(!empty($args)){
+
+            foreach($args as $key => $val){
+                if(substr( $key, 0, 5 ) === "data-"){
+                    $output .= ' '.sanitize_html_class($key).'="'.esc_attr($val).'" ';
+                }
+            }
+        }
+
+        return $output;
+    }
+
+    /**
+     * @param $args
+     *
+     * @return string
+     */
+    public static function aria_attributes($args){
+        $output = '';
+
+        if(!empty($args)){
+
+            foreach($args as $key => $val){
+                if(substr( $key, 0, 5 ) === "aria-"){
+                    $output .= ' '.sanitize_html_class($key).'="'.esc_attr($val).'" ';
+                }
+            }
+        }
+
+        return $output;
+    }
+
+    /**
+     * Build a font awesome icon from a class.
+     *
+     * @param $class
+     * @param bool $space_after
+     * @param array $extra_attributes An array of extra attributes.
+     *
+     * @return string
+     */
+    public static function icon($class,$space_after = false, $extra_attributes = array()){
+        $output = '';
+
+        if($class){
+            $classes = self::esc_classes($class);
+            if(!empty($classes)){
+                $output = '<i class="'.$classes.'" ';
+                // extra attributes
+                if(!empty($extra_attributes)){
+                    $output .= AUI_Component_Helper::extra_attributes($extra_attributes);
+                }
+                $output .= '></i>';
+                if($space_after){
+                    $output .= " ";
+                }
+            }
+        }
+
+        return $output;
+    }
+
+    /**
+     * @param $args
+     *
+     * @return string
+     */
+    public static function extra_attributes($args){
+        $output = '';
+
+        if(!empty($args)){
+
+            if( is_array($args) ){
+                foreach($args as $key => $val){
+                    $output .= ' '.sanitize_html_class($key).'="'.esc_attr($val).'" ';
+                }
+            }else{
+                $output .= ' '.$args.' ';
+            }
+
+        }
+
+        return $output;
+    }
+
+    /**
+     * @param $args
+     *
+     * @return string
+     */
+    public static function help_text($text){
+        $output = '';
+
+        if($text){
+            $output .= '<small class="form-text text-muted">'.wp_kses_post($text).'</small>';
+        }
+
+
+        return $output;
+    }
+
+    /**
+     * Replace element require context with JS.
+     *
+     * @param $input
+     *
+     * @return string|void
+     */
+    public static function element_require( $input ) {
+
+        $input = str_replace( "'", '"', $input );// we only want double quotes
+
+        $output = esc_attr( str_replace( array( "[%", "%]", "%:checked]" ), array(
+            "jQuery(form).find('[data-argument=\"",
+            "\"]').find('input,select,textarea').val()",
+            "\"]').find('input:checked').val()",
+        ), $input ) );
+
+        if($output){
+            $output = ' data-element-require="'.$output.'" ';
+        }
+
+        return $output;
+    }
+
+    /**
+     * Returns an array of allowed HTML tags and attributes for a given context.
+     *
+     * @since 0.1.41
+     *
+     * @param string|array $context The context for which to retrieve tags. Allowed values are 'post',
+     *                              'strip', 'data', 'entities', or the name of a field filter such as
+     *                              'pre_user_description'.
+     * @param array $input Input.
+     * @return array Array of allowed HTML tags and their allowed attributes.
+     */
+    public static function kses_allowed_html( $context = 'post', $input = array() ) {
+        $allowed_html = wp_kses_allowed_html( $context );
+
+        if ( is_array( $allowed_html ) ) {
+            // <iframe>
+            if ( ! isset( $allowed_html['iframe'] ) && $context == 'post' ) {
+                $allowed_html['iframe']     = array(
+                    'class'        => true,
+                    'id'           => true,
+                    'src'          => true,
+                    'width'        => true,
+                    'height'       => true,
+                    'frameborder'  => true,
+                    'marginwidth'  => true,
+                    'marginheight' => true,
+                    'scrolling'    => true,
+                    'style'        => true,
+                    'title'        => true,
+                    'allow'        => true,
+                    'allowfullscreen' => true,
+                    'data-*'       => true,
+                );
+            }
+        }
+
+        /**
+         * Filters the allowed html tags.
+         *
+         * @since 0.1.41
+         *
+         * @param array[]|string $allowed_html Allowed html tags.
+         * @param @param string|array $context The context for which to retrieve tags.
+         * @param array $input Input field.
+         */
+        return apply_filters( 'ayecode_ui_kses_allowed_html', $allowed_html, $context, $input );
+    }
+
+    /**
+     * Filters content and keeps only allowable HTML elements.
+     *
+     * This function makes sure that only the allowed HTML element names, attribute
+     * names and attribute values plus only sane HTML entities will occur in
+     * $string. You have to remove any slashes from PHP's magic quotes before you
+     * call this function.
+     *
+     * The default allowed protocols are 'http', 'https', 'ftp', 'mailto', 'news',
+     * 'irc', 'gopher', 'nntp', 'feed', 'telnet, 'mms', 'rtsp' and 'svn'. This
+     * covers all common link protocols, except for 'javascript' which should not
+     * be allowed for untrusted users.
+     *
+     * @since 0.1.41
+     *
+     * @param string|array $value Content to filter through kses.
+     * @param array  $input       Input Field.
+     * @return string Filtered content with only allowed HTML elements.
+     */
+    public static function _sanitize_html_field( $value, $input = array() ) {
+        if ( $value === '' ) {
+            return $value;
+        }
+
+        $allowed_html = self::kses_allowed_html( 'post', $input );
+
+        if ( ! is_array( $allowed_html ) ) {
+            $allowed_html = wp_kses_allowed_html( 'post' );
+        }
+
+        $filtered = trim( wp_unslash( $value ) );
+        $filtered = wp_kses( $filtered, $allowed_html );
+        $filtered = balanceTags( $filtered ); // Balances tags
+
+        return $filtered;
+    }
+
+    /**
+     * Navigates through an array, object, or scalar, and removes slashes from the values.
+     *
+     * @since 0.1.41
+     *
+     * @param mixed $value The value to be stripped.
+     * @param array  $input Input Field.
+     * @return mixed Stripped value.
+     */
+    public static function sanitize_html_field( $value, $input = array() ) {
+        $original = $value;
+
+        if ( is_array( $value ) ) {
+            foreach ( $value as $index => $item ) {
+                $value[ $index ] = self::_sanitize_html_field( $value, $input );
+            }
+        } elseif ( is_object( $value ) ) {
+            $object_vars = get_object_vars( $value );
+
+            foreach ( $object_vars as $property_name => $property_value ) {
+                $value->$property_name = self::_sanitize_html_field( $property_value, $input );
+            }
+        } else {
+            $value = self::_sanitize_html_field( $value, $input );
+        }
+
+        /**
+         * Filters content and keeps only allowable HTML elements.
+         *
+         * @since 0.1.41
+         *
+         * @param string|array $value Content to filter through kses.
+         * @param string|array $value Original content without filter.
+         * @param array  $input       Input Field.
+         */
+        return apply_filters( 'ayecode_ui_sanitize_html_field', $value, $original, $input );
+    }
 }
\ No newline at end of file

Spacing +81 added lines, -81 removed lines

@@ -1,6 +1,6 @@ 
 <?php
 
-if ( ! defined( 'ABSPATH' ) ) {
+if (!defined('ABSPATH')) {
 	exit; // Exit if accessed directly
 }
 
@@ -19,12 +19,12 @@ 
 	 *
 	 * @return string
 	 */
-	public static function name($text,$multiple = false){
+	public static function name($text, $multiple = false) {
 		$output = '';
 
-		if($text){
-			$is_multiple = strpos($text, '[') === false && $multiple  ? '[]' : '';
-			$output = ' name="'.esc_attr($text).$is_multiple.'" ';
+		if ($text) {
+			$is_multiple = strpos($text, '[') === false && $multiple ? '[]' : '';
+			$output = ' name="' . esc_attr($text) . $is_multiple . '" ';
 		}
 
 		return $output;
@@ -37,11 +37,11 @@ 
 	 *
 	 * @return string The sanitized item.
 	 */
-	public static function id($text){
+	public static function id($text) {
 		$output = '';
 
-		if($text){
-			$output = ' id="'.sanitize_html_class($text).'" ';
+		if ($text) {
+			$output = ' id="' . sanitize_html_class($text) . '" ';
 		}
 
 		return $output;
@@ -54,11 +54,11 @@ 
 	 *
 	 * @return string The sanitized item.
 	 */
-	public static function title($text){
+	public static function title($text) {
 		$output = '';
 
-		if($text){
-			$output = ' title="'.esc_attr($text).'" ';
+		if ($text) {
+			$output = ' title="' . esc_attr($text) . '" ';
 		}
 
 		return $output;
@@ -71,11 +71,11 @@ 
 	 *
 	 * @return string The sanitized item.
 	 */
-	public static function value($text){
+	public static function value($text) {
 		$output = '';
 
-		if($text){
-			$output = ' value="'.sanitize_text_field($text).'" ';
+		if ($text) {
+			$output = ' value="' . sanitize_text_field($text) . '" ';
 		}
 
 		return $output;
@@ -88,13 +88,13 @@ 
 	 *
 	 * @return string The sanitized item.
 	 */
-	public static function class_attr($text){
+	public static function class_attr($text) {
 		$output = '';
 
-		if($text){
+		if ($text) {
 			$classes = self::esc_classes($text);
-			if(!empty($classes)){
-				$output = ' class="'.$classes.'" ';
+			if (!empty($classes)) {
+				$output = ' class="' . $classes . '" ';
 			}
 		}
 
@@ -108,15 +108,15 @@ 
 	 *
 	 * @return string
 	 */
-	public static function esc_classes($text){
+	public static function esc_classes($text) {
 		$output = '';
 
-		if($text){
-			$classes = explode(" ",$text);
-			$classes = array_map("trim",$classes);
-			$classes = array_map("sanitize_html_class",$classes);
-			if(!empty($classes)){
-				$output = implode(" ",$classes);
+		if ($text) {
+			$classes = explode(" ", $text);
+			$classes = array_map("trim", $classes);
+			$classes = array_map("sanitize_html_class", $classes);
+			if (!empty($classes)) {
+				$output = implode(" ", $classes);
 			}
 		}
 
@@ -129,14 +129,14 @@ 
 	 *
 	 * @return string
 	 */
-	public static function data_attributes($args){
+	public static function data_attributes($args) {
 		$output = '';
 
-		if(!empty($args)){
+		if (!empty($args)) {
 
-			foreach($args as $key => $val){
-				if(substr( $key, 0, 5 ) === "data-"){
-					$output .= ' '.sanitize_html_class($key).'="'.esc_attr($val).'" ';
+			foreach ($args as $key => $val) {
+				if (substr($key, 0, 5) === "data-") {
+					$output .= ' ' . sanitize_html_class($key) . '="' . esc_attr($val) . '" ';
 				}
 			}
 		}
@@ -149,14 +149,14 @@ 
 	 *
 	 * @return string
 	 */
-	public static function aria_attributes($args){
+	public static function aria_attributes($args) {
 		$output = '';
 
-		if(!empty($args)){
+		if (!empty($args)) {
 
-			foreach($args as $key => $val){
-				if(substr( $key, 0, 5 ) === "aria-"){
-					$output .= ' '.sanitize_html_class($key).'="'.esc_attr($val).'" ';
+			foreach ($args as $key => $val) {
+				if (substr($key, 0, 5) === "aria-") {
+					$output .= ' ' . sanitize_html_class($key) . '="' . esc_attr($val) . '" ';
 				}
 			}
 		}
@@ -173,19 +173,19 @@ 
 	 *
 	 * @return string
 	 */
-	public static function icon($class,$space_after = false, $extra_attributes = array()){
+	public static function icon($class, $space_after = false, $extra_attributes = array()) {
 		$output = '';
 
-		if($class){
+		if ($class) {
 			$classes = self::esc_classes($class);
-			if(!empty($classes)){
-				$output = '<i class="'.$classes.'" ';
+			if (!empty($classes)) {
+				$output = '<i class="' . $classes . '" ';
 				// extra attributes
-				if(!empty($extra_attributes)){
+				if (!empty($extra_attributes)) {
 					$output .= AUI_Component_Helper::extra_attributes($extra_attributes);
 				}
 				$output .= '></i>';
-				if($space_after){
+				if ($space_after) {
 					$output .= " ";
 				}
 			}
@@ -199,17 +199,17 @@ 
 	 *
 	 * @return string
 	 */
-	public static function extra_attributes($args){
+	public static function extra_attributes($args) {
 		$output = '';
 
-		if(!empty($args)){
+		if (!empty($args)) {
 
-			if( is_array($args) ){
-				foreach($args as $key => $val){
-					$output .= ' '.sanitize_html_class($key).'="'.esc_attr($val).'" ';
+			if (is_array($args)) {
+				foreach ($args as $key => $val) {
+					$output .= ' ' . sanitize_html_class($key) . '="' . esc_attr($val) . '" ';
 				}
-			}else{
-				$output .= ' '.$args.' ';
+			} else {
+				$output .= ' ' . $args . ' ';
 			}
 
 		}
@@ -222,11 +222,11 @@ 
 	 *
 	 * @return string
 	 */
-	public static function help_text($text){
+	public static function help_text($text) {
 		$output = '';
 
-		if($text){
-			$output .= '<small class="form-text text-muted">'.wp_kses_post($text).'</small>';
+		if ($text) {
+			$output .= '<small class="form-text text-muted">' . wp_kses_post($text) . '</small>';
 		}
 
 
@@ -240,18 +240,18 @@ 
 	 *
 	 * @return string|void
 	 */
-	public static function element_require( $input ) {
+	public static function element_require($input) {
 
-		$input = str_replace( "'", '"', $input );// we only want double quotes
+		$input = str_replace("'", '"', $input); // we only want double quotes
 
-		$output = esc_attr( str_replace( array( "[%", "%]", "%:checked]" ), array(
+		$output = esc_attr(str_replace(array("[%", "%]", "%:checked]"), array(
 			"jQuery(form).find('[data-argument=\"",
 			"\"]').find('input,select,textarea').val()",
 			"\"]').find('input:checked').val()",
-		), $input ) );
+		), $input));
 
-		if($output){
-			$output = ' data-element-require="'.$output.'" ';
+		if ($output) {
+			$output = ' data-element-require="' . $output . '" ';
 		}
 
 		return $output;
@@ -268,13 +268,13 @@ 
 	 * @param array $input Input.
 	 * @return array Array of allowed HTML tags and their allowed attributes.
 	 */
-	public static function kses_allowed_html( $context = 'post', $input = array() ) {
-		$allowed_html = wp_kses_allowed_html( $context );
+	public static function kses_allowed_html($context = 'post', $input = array()) {
+		$allowed_html = wp_kses_allowed_html($context);
 
-		if ( is_array( $allowed_html ) ) {
+		if (is_array($allowed_html)) {
 			// <iframe>
-			if ( ! isset( $allowed_html['iframe'] ) && $context == 'post' ) {
-				$allowed_html['iframe']     = array(
+			if (!isset($allowed_html['iframe']) && $context == 'post') {
+				$allowed_html['iframe'] = array(
 					'class'        => true,
 					'id'           => true,
 					'src'          => true,
@@ -302,7 +302,7 @@ 
 		 * @param @param string|array $context The context for which to retrieve tags.
 		 * @param array $input Input field.
 		 */
-		return apply_filters( 'ayecode_ui_kses_allowed_html', $allowed_html, $context, $input );
+		return apply_filters('ayecode_ui_kses_allowed_html', $allowed_html, $context, $input);
 	}
 
 	/**
@@ -324,20 +324,20 @@ 
 	 * @param array  $input       Input Field.
 	 * @return string Filtered content with only allowed HTML elements.
 	 */
-	public static function _sanitize_html_field( $value, $input = array() ) {
-		if ( $value === '' ) {
+	public static function _sanitize_html_field($value, $input = array()) {
+		if ($value === '') {
 			return $value;
 		}
 
-		$allowed_html = self::kses_allowed_html( 'post', $input );
+		$allowed_html = self::kses_allowed_html('post', $input);
 
-		if ( ! is_array( $allowed_html ) ) {
-			$allowed_html = wp_kses_allowed_html( 'post' );
+		if (!is_array($allowed_html)) {
+			$allowed_html = wp_kses_allowed_html('post');
 		}
 
-		$filtered = trim( wp_unslash( $value ) );
-		$filtered = wp_kses( $filtered, $allowed_html );
-		$filtered = balanceTags( $filtered ); // Balances tags
+		$filtered = trim(wp_unslash($value));
+		$filtered = wp_kses($filtered, $allowed_html);
+		$filtered = balanceTags($filtered); // Balances tags
 
 		return $filtered;
 	}
@@ -351,21 +351,21 @@ 
 	 * @param array  $input Input Field.
 	 * @return mixed Stripped value.
 	 */
-	public static function sanitize_html_field( $value, $input = array() ) {
+	public static function sanitize_html_field($value, $input = array()) {
 		$original = $value;
 
-		if ( is_array( $value ) ) {
-			foreach ( $value as $index => $item ) {
-				$value[ $index ] = self::_sanitize_html_field( $value, $input );
+		if (is_array($value)) {
+			foreach ($value as $index => $item) {
+				$value[$index] = self::_sanitize_html_field($value, $input);
 			}
-		} elseif ( is_object( $value ) ) {
-			$object_vars = get_object_vars( $value );
+		} elseif (is_object($value)) {
+			$object_vars = get_object_vars($value);
 
-			foreach ( $object_vars as $property_name => $property_value ) {
-				$value->$property_name = self::_sanitize_html_field( $property_value, $input );
+			foreach ($object_vars as $property_name => $property_value) {
+				$value->$property_name = self::_sanitize_html_field($property_value, $input);
 			}
 		} else {
-			$value = self::_sanitize_html_field( $value, $input );
+			$value = self::_sanitize_html_field($value, $input);
 		}
 
 		/**
@@ -377,6 +377,6 @@ 
 		 * @param string|array $value Original content without filter.
 		 * @param array  $input       Input Field.
 		 */
-		return apply_filters( 'ayecode_ui_sanitize_html_field', $value, $original, $input );
+		return apply_filters('ayecode_ui_sanitize_html_field', $value, $original, $input);
 	}
 }
\ No newline at end of file