AyeCode / invoicing

includes/admin/views/wizard-plugins.php

Indentation +1 added lines, -1 removed lines

@@ -27,7 +27,7 @@
 						<input type="checkbox" name="plugins[<?php echo esc_attr( $plugin['slug'] ); ?>]" value="<?php echo esc_attr( $plugin['file'] ); ?>" class="custom-control-input"  
                                                                         <?php
                         if ( is_plugin_active( $plugin['slug'] ) ) {
-																								echo 'checked';}
+                                                                                                echo 'checked';}
 ?>
 >
 						<label class="custom-control-label" for="ac-setting-updates"></label>

includes/admin/meta-boxes/class-getpaid-meta-box-invoice-shipping-address.php

Indentation +34 added lines, -34 removed lines

@@ -7,7 +7,7 @@ 
  */
 
 if ( ! defined( 'ABSPATH' ) ) {
-	exit; // Exit if accessed directly
+    exit; // Exit if accessed directly
 }
 
 /**
@@ -15,22 +15,22 @@ 
  */
 class GetPaid_Meta_Box_Invoice_Shipping_Address {
 
-	/**
-	 * Output the metabox.
-	 *
-	 * @param WP_Post $post
-	 */
-	public static function output( $post ) {
+    /**
+     * Output the metabox.
+     *
+     * @param WP_Post $post
+     */
+    public static function output( $post ) {
 
-		// Retrieve shipping address.
-		$shipping_address = get_post_meta( $post->ID, 'shipping_address', true );
+        // Retrieve shipping address.
+        $shipping_address = get_post_meta( $post->ID, 'shipping_address', true );
 
-		// Abort if it is invalid.
-		if ( ! is_array( $shipping_address ) ) {
-			return;
-		}
+        // Abort if it is invalid.
+        if ( ! is_array( $shipping_address ) ) {
+            return;
+        }
 
-		?>
+        ?>
 
 		<div class="bsui">
 
@@ -68,31 +68,31 @@ 
 
 		<?php
 
-	}
+    }
 
-	/**
-	 * Prepares a value.
-	 *
-	 * @param array $address
-	 * @param string $key
-	 * @return string
-	 */
-	public static function prepare_for_display( $address, $key ) {
+    /**
+     * Prepares a value.
+     *
+     * @param array $address
+     * @param string $key
+     * @return string
+     */
+    public static function prepare_for_display( $address, $key ) {
 
-		// Prepare the value.
-		$value = $address[ $key ];
+        // Prepare the value.
+        $value = $address[ $key ];
 
-		if ( $key == 'country' ) {
-			$value = wpinv_country_name( $value );
-		}
+        if ( $key == 'country' ) {
+            $value = wpinv_country_name( $value );
+        }
 
-		if ( $key == 'state' ) {
-			$country = isset( $address['country'] ) ? $address['country'] : wpinv_get_default_country();
-			$value = wpinv_state_name( $value, $country );
-		}
+        if ( $key == 'state' ) {
+            $country = isset( $address['country'] ) ? $address['country'] : wpinv_get_default_country();
+            $value = wpinv_state_name( $value, $country );
+        }
 
-		return esc_html( $value );
+        return esc_html( $value );
 
-	}
+    }
 
 }

includes/admin/meta-boxes/class-getpaid-meta-box-discount-details.php

Indentation +26 added lines, -26 removed lines

@@ -8,7 +8,7 @@ 
  */
 
 if ( ! defined( 'ABSPATH' ) ) {
-	exit; // Exit if accessed directly
+    exit; // Exit if accessed directly
 }
 
 /**
@@ -17,10 +17,10 @@ 
 class GetPaid_Meta_Box_Discount_Details {
 
     /**
-	 * Output the metabox.
-	 *
-	 * @param WP_Post $post
-	 */
+     * Output the metabox.
+     *
+     * @param WP_Post $post
+     */
     public static function output( $post ) {
 
         // Prepare the discount.
@@ -396,35 +396,35 @@ 
     }
 
     /**
-	 * Save meta box data.
-	 *
-	 * @param int $post_id
-	 */
-	public static function save( $post_id ) {
+     * Save meta box data.
+     *
+     * @param int $post_id
+     */
+    public static function save( $post_id ) {
 
         // Prepare the discount.
         $discount = new WPInv_Discount( $post_id );
 
         // Load new data.
         $discount->set_props(
-			array(
-				'code'           => isset( $_POST['wpinv_discount_code'] ) ? wpinv_clean( $_POST['wpinv_discount_code'] ) : null,
-				'amount'         => isset( $_POST['wpinv_discount_amount'] ) ? floatval( $_POST['wpinv_discount_amount'] ) : null,
-				'start'          => isset( $_POST['wpinv_discount_start'] ) ? wpinv_clean( $_POST['wpinv_discount_start'] ) : null,
-				'expiration'     => isset( $_POST['wpinv_discount_expiration'] ) ? wpinv_clean( $_POST['wpinv_discount_expiration'] ) : null,
-				'is_single_use'  => ! empty( $_POST['wpinv_discount_single_use'] ),
+            array(
+                'code'           => isset( $_POST['wpinv_discount_code'] ) ? wpinv_clean( $_POST['wpinv_discount_code'] ) : null,
+                'amount'         => isset( $_POST['wpinv_discount_amount'] ) ? floatval( $_POST['wpinv_discount_amount'] ) : null,
+                'start'          => isset( $_POST['wpinv_discount_start'] ) ? wpinv_clean( $_POST['wpinv_discount_start'] ) : null,
+                'expiration'     => isset( $_POST['wpinv_discount_expiration'] ) ? wpinv_clean( $_POST['wpinv_discount_expiration'] ) : null,
+                'is_single_use'  => ! empty( $_POST['wpinv_discount_single_use'] ),
                 'type'           => isset( $_POST['wpinv_discount_type'] ) ? wpinv_clean( $_POST['wpinv_discount_type'] ) : null,
-				'is_recurring'   => ! empty( $_POST['wpinv_discount_recurring'] ),
-				'items'          => isset( $_POST['wpinv_discount_items'] ) ? wpinv_clean( $_POST['wpinv_discount_items'] ) : array(),
-				'excluded_items' => isset( $_POST['wpinv_discount_excluded_items'] ) ? wpinv_clean( $_POST['wpinv_discount_excluded_items'] ) : array(),
+                'is_recurring'   => ! empty( $_POST['wpinv_discount_recurring'] ),
+                'items'          => isset( $_POST['wpinv_discount_items'] ) ? wpinv_clean( $_POST['wpinv_discount_items'] ) : array(),
+                'excluded_items' => isset( $_POST['wpinv_discount_excluded_items'] ) ? wpinv_clean( $_POST['wpinv_discount_excluded_items'] ) : array(),
                 'required_items' => isset( $_POST['wpinv_discount_required_items'] ) ? wpinv_clean( $_POST['wpinv_discount_required_items'] ) : array(),
-				'max_uses'       => isset( $_POST['wpinv_discount_max_uses'] ) ? intval( $_POST['wpinv_discount_max_uses'] ) : null,
-				'min_total'      => isset( $_POST['wpinv_discount_min_total'] ) ? floatval( $_POST['wpinv_discount_min_total'] ) : null,
-				'max_total'      => isset( $_POST['wpinv_discount_max_total'] ) ? floatval( $_POST['wpinv_discount_max_total'] ) : null,
-			)
+                'max_uses'       => isset( $_POST['wpinv_discount_max_uses'] ) ? intval( $_POST['wpinv_discount_max_uses'] ) : null,
+                'min_total'      => isset( $_POST['wpinv_discount_min_total'] ) ? floatval( $_POST['wpinv_discount_min_total'] ) : null,
+                'max_total'      => isset( $_POST['wpinv_discount_max_total'] ) ? floatval( $_POST['wpinv_discount_max_total'] ) : null,
+            )
         );
 
-		$discount->save();
-		do_action( 'getpaid_discount_metabox_save', $post_id, $discount );
-	}
+        $discount->save();
+        do_action( 'getpaid_discount_metabox_save', $post_id, $discount );
+    }
 }

includes/admin/class-wpinv-admin-menus.php

Indentation +11 added lines, -11 removed lines

@@ -24,14 +24,14 @@ 
     }
 
     /**
-	 * Highlights sub menus.
-	 */
-	public function set_admin_menu_class() {
-		global $current_screen, $parent_file, $submenu_file;
+     * Highlights sub menus.
+     */
+    public function set_admin_menu_class() {
+        global $current_screen, $parent_file, $submenu_file;
 
         if ( ! empty( $current_screen->id ) && in_array( $current_screen->id, array( 'wpi_discount', 'wpi_payment_form', 'wpi_invoice' ) ) ) {
-			$parent_file = 'wpinv';
-			$submenu_file = 'edit.php?post_type=' . $current_screen->id;
+            $parent_file = 'wpinv';
+            $submenu_file = 'edit.php?post_type=' . $current_screen->id;
         }
 
     }
@@ -165,8 +165,8 @@ 
                 foreach ( wpinv_get_settings_tabs() as $tab_id => $tab_name ) {
                     $tab_url = add_query_arg(
                         array(
-							'settings-updated' => false,
-							'tab'              => $tab_id,
+                            'settings-updated' => false,
+                            'tab'              => $tab_id,
                         ),
                         'admin.php?page=wpinv-settings'
                     );
@@ -193,9 +193,9 @@ 
                     $number++;
                     $tab_url = add_query_arg(
                         array(
-							'settings-updated' => false,
-							'tab'              => $active_tab,
-							'section'          => $section_id,
+                            'settings-updated' => false,
+                            'tab'              => $active_tab,
+                            'section'          => $section_id,
                         ),
                         admin_url( 'admin.php?page=wpinv-settings' )
                     );

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

Indentation +539 added lines, -539 removed lines

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

includes/api/class-getpaid-rest-report-top-earners-controller.php

Indentation +42 added lines, -42 removed lines

@@ -18,50 +18,50 @@
  */
 class GetPaid_REST_Report_Top_Earners_Controller extends GetPaid_REST_Report_Top_Sellers_Controller {
 
-	/**
-	 * Route base.
-	 *
-	 * @var string
-	 */
-	protected $rest_base = 'reports/top_earners';
+    /**
+     * Route base.
+     *
+     * @var string
+     */
+    protected $rest_base = 'reports/top_earners';
 
-	/**
-	 * Get all data needed for this report and store in the class.
-	 */
-	protected function query_report_data() {
+    /**
+     * Get all data needed for this report and store in the class.
+     */
+    protected function query_report_data() {
 
-		$this->report_data = GetPaid_Reports_Helper::get_invoice_report_data(
-			array(
-				'data'         => array(
-					'quantity'  => array(
-						'type'     => 'invoice_item',
-						'function' => 'SUM',
-						'name'     => 'invoice_item_qty',
-					),
-					'item_id'   => array(
-						'type'     => 'invoice_item',
-						'function' => '',
-						'name'     => 'invoice_item_id',
-					),
-					'item_name' => array(
-						'type'     => 'invoice_item',
-						'function' => '',
-						'name'     => 'invoice_item_name',
-					),
-					'price'     => array(
-						'type'     => 'invoice_item',
-						'function' => 'SUM',
-						'name'     => 'invoice_item_price',
-					),
-				),
-				'group_by'     => 'invoice_item_id',
-				'order_by'     => 'invoice_item_price DESC',
-				'query_type'   => 'get_results',
-				'limit'        => 10,
-				'filter_range' => $this->report_range,
-			)
-		);
+        $this->report_data = GetPaid_Reports_Helper::get_invoice_report_data(
+            array(
+                'data'         => array(
+                    'quantity'  => array(
+                        'type'     => 'invoice_item',
+                        'function' => 'SUM',
+                        'name'     => 'invoice_item_qty',
+                    ),
+                    'item_id'   => array(
+                        'type'     => 'invoice_item',
+                        'function' => '',
+                        'name'     => 'invoice_item_id',
+                    ),
+                    'item_name' => array(
+                        'type'     => 'invoice_item',
+                        'function' => '',
+                        'name'     => 'invoice_item_name',
+                    ),
+                    'price'     => array(
+                        'type'     => 'invoice_item',
+                        'function' => 'SUM',
+                        'name'     => 'invoice_item_price',
+                    ),
+                ),
+                'group_by'     => 'invoice_item_id',
+                'order_by'     => 'invoice_item_price DESC',
+                'query_type'   => 'get_results',
+                'limit'        => 10,
+                'filter_range' => $this->report_range,
+            )
+        );
 
-	}
+    }
 
 }

includes/api/class-getpaid-rest-report-top-sellers-controller.php

Indentation +175 added lines, -175 removed lines

@@ -18,179 +18,179 @@
  */
 class GetPaid_REST_Report_Top_Sellers_Controller extends GetPaid_REST_Report_Sales_Controller {
 
-	/**
-	 * Route base.
-	 *
-	 * @var string
-	 */
-	protected $rest_base = 'reports/top_sellers';
-
-	/**
-	 * Get top sellers report.
-	 *
-	 * @param WP_REST_Request $request
-	 * @return array|WP_Error
-	 */
-	public function get_items( $request ) {
-
-		// Prepare items.
-		$this->report_range = $this->get_date_range( $request );
-		$report_data        = $this->get_report_data();
-
-		$top_sellers = array();
-
-		foreach ( $report_data as $item ) {
-
-			$item_obj  = new WPInv_Item( $item );
-			$item_name = $item->invoice_item_name;
-			$item_qty  = floatval( $item->invoice_item_qty );
-			$item_id   = absint( $item->invoice_item_id );
-			$price     = sanitize_text_field( wpinv_price( $item->invoice_item_price ) );
-
-			$item_obj  = new WPInv_Item( $item_id );
-
-			if ( $item_obj->exists() ) {
-				$item_name = $item_obj->get_name();
-			} else {
-				$item_id   = 0;
-			}
-
-			$top_sellers[] = array(
-				'name'               => sanitize_text_field( $item_name ),
-				'item_id'            => $item_id,
-				'quantity'           => $item_qty,
-				'earnings'           => wpinv_round_amount( $item->invoice_item_price ),
-				'earnings_formatted' => sanitize_text_field( wpinv_price( $price ) ),
-			);
-
-		}
-
-		$data = array();
-		foreach ( $top_sellers as $top_seller ) {
-			$item   = $this->prepare_item_for_response( (object) $top_seller, $request );
-			$data[] = $this->prepare_response_for_collection( $item );
-		}
-
-		return rest_ensure_response( $data );
-
-	}
-
-	/**
-	 * Prepare a report sales object for serialization.
-	 *
-	 * @param stdClass $top_seller
-	 * @param WP_REST_Request $request Request object.
-	 * @return WP_REST_Response $response Response data.
-	 */
-	public function prepare_item_for_response( $top_seller, $request ) {
-		$data    = (array) $top_seller;
-
-		$context = ! empty( $request['context'] ) ? $request['context'] : 'view';
-		$data    = $this->add_additional_fields_to_object( $data, $request );
-		$data    = $this->filter_response_by_context( $data, $context );
-
-		// Wrap the data in a response object.
-		$response = rest_ensure_response( $data );
-		$links = array(
-			'about' => array(
-				'href' => rest_url( sprintf( '%s/reports', $this->namespace ) ),
-			),
-		);
-
-		if ( ! empty( $top_seller->item_id ) ) {
-			$links['item']   = array(
-				'href'       => rest_url( sprintf( '/%s/items/%s', $this->namespace, $top_seller->item_id ) ),
-				'embeddable' => true,
-			);
-		}
-
-		$response->add_links( $links );
-		return apply_filters( 'getpaid_rest_prepare_report_' . $this->rest_base, $response, $top_seller, $request );
-	}
-
-	/**
-	 * Get all data needed for this report and store in the class.
-	 */
-	protected function query_report_data() {
-
-		$this->report_data = GetPaid_Reports_Helper::get_invoice_report_data(
-			array(
-				'data'         => array(
-					'quantity'  => array(
-						'type'     => 'invoice_item',
-						'function' => 'SUM',
-						'name'     => 'invoice_item_qty',
-					),
-					'item_id'   => array(
-						'type'     => 'invoice_item',
-						'function' => '',
-						'name'     => 'invoice_item_id',
-					),
-					'item_name' => array(
-						'type'     => 'invoice_item',
-						'function' => '',
-						'name'     => 'invoice_item_name',
-					),
-					'price'     => array(
-						'type'     => 'invoice_item',
-						'function' => 'SUM',
-						'name'     => 'invoice_item_price',
-					),
-				),
-				'group_by'     => 'invoice_item_id',
-				'order_by'     => 'invoice_item_qty DESC',
-				'query_type'   => 'get_results',
-				'limit'        => 10,
-				'filter_range' => $this->report_range,
-			)
-		);
-
-	}
-
-	/**
-	 * Get the Report's schema, conforming to JSON Schema.
-	 *
-	 * @return array
-	 */
-	public function get_item_schema() {
-		$schema = array(
-			'$schema'    => 'http://json-schema.org/draft-04/schema#',
-			'title'      => $this->rest_base,
-			'type'       => 'object',
-			'properties' => array(
-				'name'                => array(
-					'description' => __( 'Item name.', 'invoicing' ),
-					'type'        => 'string',
-					'context'     => array( 'view' ),
-					'readonly'    => true,
-				),
-				'item_id'             => array(
-					'description' => __( 'Item ID.', 'invoicing' ),
-					'type'        => 'integer',
-					'context'     => array( 'view' ),
-					'readonly'    => true,
-				),
-				'quantity'            => array(
-					'description' => __( 'Total number of purchases.', 'invoicing' ),
-					'type'        => 'number',
-					'context'     => array( 'view' ),
-					'readonly'    => true,
-				),
-				'earnings'            => array(
-					'description' => __( 'Total earnings for the item.', 'invoicing' ),
-					'type'        => 'number',
-					'context'     => array( 'view' ),
-					'readonly'    => true,
-				),
-				'earnings_formatted"' => array(
-					'description' => __( 'Total earnings (formatted) for the item.', 'invoicing' ),
-					'type'        => 'string',
-					'context'     => array( 'view' ),
-					'readonly'    => true,
-				),
-			),
-		);
-
-		return $this->add_additional_fields_schema( $schema );
-	}
+    /**
+     * Route base.
+     *
+     * @var string
+     */
+    protected $rest_base = 'reports/top_sellers';
+
+    /**
+     * Get top sellers report.
+     *
+     * @param WP_REST_Request $request
+     * @return array|WP_Error
+     */
+    public function get_items( $request ) {
+
+        // Prepare items.
+        $this->report_range = $this->get_date_range( $request );
+        $report_data        = $this->get_report_data();
+
+        $top_sellers = array();
+
+        foreach ( $report_data as $item ) {
+
+            $item_obj  = new WPInv_Item( $item );
+            $item_name = $item->invoice_item_name;
+            $item_qty  = floatval( $item->invoice_item_qty );
+            $item_id   = absint( $item->invoice_item_id );
+            $price     = sanitize_text_field( wpinv_price( $item->invoice_item_price ) );
+
+            $item_obj  = new WPInv_Item( $item_id );
+
+            if ( $item_obj->exists() ) {
+                $item_name = $item_obj->get_name();
+            } else {
+                $item_id   = 0;
+            }
+
+            $top_sellers[] = array(
+                'name'               => sanitize_text_field( $item_name ),
+                'item_id'            => $item_id,
+                'quantity'           => $item_qty,
+                'earnings'           => wpinv_round_amount( $item->invoice_item_price ),
+                'earnings_formatted' => sanitize_text_field( wpinv_price( $price ) ),
+            );
+
+        }
+
+        $data = array();
+        foreach ( $top_sellers as $top_seller ) {
+            $item   = $this->prepare_item_for_response( (object) $top_seller, $request );
+            $data[] = $this->prepare_response_for_collection( $item );
+        }
+
+        return rest_ensure_response( $data );
+
+    }
+
+    /**
+     * Prepare a report sales object for serialization.
+     *
+     * @param stdClass $top_seller
+     * @param WP_REST_Request $request Request object.
+     * @return WP_REST_Response $response Response data.
+     */
+    public function prepare_item_for_response( $top_seller, $request ) {
+        $data    = (array) $top_seller;
+
+        $context = ! empty( $request['context'] ) ? $request['context'] : 'view';
+        $data    = $this->add_additional_fields_to_object( $data, $request );
+        $data    = $this->filter_response_by_context( $data, $context );
+
+        // Wrap the data in a response object.
+        $response = rest_ensure_response( $data );
+        $links = array(
+            'about' => array(
+                'href' => rest_url( sprintf( '%s/reports', $this->namespace ) ),
+            ),
+        );
+
+        if ( ! empty( $top_seller->item_id ) ) {
+            $links['item']   = array(
+                'href'       => rest_url( sprintf( '/%s/items/%s', $this->namespace, $top_seller->item_id ) ),
+                'embeddable' => true,
+            );
+        }
+
+        $response->add_links( $links );
+        return apply_filters( 'getpaid_rest_prepare_report_' . $this->rest_base, $response, $top_seller, $request );
+    }
+
+    /**
+     * Get all data needed for this report and store in the class.
+     */
+    protected function query_report_data() {
+
+        $this->report_data = GetPaid_Reports_Helper::get_invoice_report_data(
+            array(
+                'data'         => array(
+                    'quantity'  => array(
+                        'type'     => 'invoice_item',
+                        'function' => 'SUM',
+                        'name'     => 'invoice_item_qty',
+                    ),
+                    'item_id'   => array(
+                        'type'     => 'invoice_item',
+                        'function' => '',
+                        'name'     => 'invoice_item_id',
+                    ),
+                    'item_name' => array(
+                        'type'     => 'invoice_item',
+                        'function' => '',
+                        'name'     => 'invoice_item_name',
+                    ),
+                    'price'     => array(
+                        'type'     => 'invoice_item',
+                        'function' => 'SUM',
+                        'name'     => 'invoice_item_price',
+                    ),
+                ),
+                'group_by'     => 'invoice_item_id',
+                'order_by'     => 'invoice_item_qty DESC',
+                'query_type'   => 'get_results',
+                'limit'        => 10,
+                'filter_range' => $this->report_range,
+            )
+        );
+
+    }
+
+    /**
+     * Get the Report's schema, conforming to JSON Schema.
+     *
+     * @return array
+     */
+    public function get_item_schema() {
+        $schema = array(
+            '$schema'    => 'http://json-schema.org/draft-04/schema#',
+            'title'      => $this->rest_base,
+            'type'       => 'object',
+            'properties' => array(
+                'name'                => array(
+                    'description' => __( 'Item name.', 'invoicing' ),
+                    'type'        => 'string',
+                    'context'     => array( 'view' ),
+                    'readonly'    => true,
+                ),
+                'item_id'             => array(
+                    'description' => __( 'Item ID.', 'invoicing' ),
+                    'type'        => 'integer',
+                    'context'     => array( 'view' ),
+                    'readonly'    => true,
+                ),
+                'quantity'            => array(
+                    'description' => __( 'Total number of purchases.', 'invoicing' ),
+                    'type'        => 'number',
+                    'context'     => array( 'view' ),
+                    'readonly'    => true,
+                ),
+                'earnings'            => array(
+                    'description' => __( 'Total earnings for the item.', 'invoicing' ),
+                    'type'        => 'number',
+                    'context'     => array( 'view' ),
+                    'readonly'    => true,
+                ),
+                'earnings_formatted"' => array(
+                    'description' => __( 'Total earnings (formatted) for the item.', 'invoicing' ),
+                    'type'        => 'string',
+                    'context'     => array( 'view' ),
+                    'readonly'    => true,
+                ),
+            ),
+        );
+
+        return $this->add_additional_fields_schema( $schema );
+    }
 }

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

Indentation +156 added lines, -156 removed lines

@@ -15,168 +15,168 @@
 class WPInv_REST_Items_Controller extends GetPaid_REST_Posts_Controller {
 
     /**
-	 * Post type.
-	 *
-	 * @var string
-	 */
-	protected $post_type = 'wpi_item';
-
-	/**
-	 * The base of this controller's route.
-	 *
-	 * @since 1.0.13
-	 * @var string
-	 */
-	protected $rest_base = 'items';
-
-	/** Contains this controller's class name.
-	 *
-	 * @var string
-	 */
-	public $crud_class = 'WPInv_Item';
-
-	/**
-	 * Registers the routes for the objects of the controller.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @see register_rest_route()
-	 */
-	public function register_namespace_routes( $namespace ) {
-
-		parent::register_namespace_routes( $namespace );
-
-		register_rest_route(
-			$this->namespace,
-			'/' . $this->rest_base . '/item-types',
-			array(
-				array(
-					'methods'             => WP_REST_Server::READABLE,
-					'callback'            => array( $this, 'get_item_types' ),
-					'permission_callback' => array( $this, 'get_items_permissions_check' ),
-				),
-			)
-		);
-
-	}
-
-	/**
-	 * Handles rest requests for item types.
-	 *
-	 * @since 1.0.13
-	 *
-	 *
-	 * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
-	 */
-	public function get_item_types() {
-		return rest_ensure_response( wpinv_get_item_types() );
-	}
+     * Post type.
+     *
+     * @var string
+     */
+    protected $post_type = 'wpi_item';
 
     /**
-	 * Retrieves the query params for the items collection.
-	 *
-	 * @since 1.0.13
-	 *
-	 * @return array Collection parameters.
-	 */
-	public function get_collection_params() {
-
-		$params = array_merge(
-			parent::get_collection_params(),
-        	array(
-
-				// Item types
-				'type' => array(
-					'description'       => __( 'Type of items to fetch.', 'invoicing' ),
-					'type'              => array( 'array', 'string' ),
-					'default'           => 'any',
-					'validate_callback' => 'rest_validate_request_arg',
-					'sanitize_callback' => 'wpinv_parse_list',
-					'items'             => array(
-						'enum' => array_merge( array( 'any' ), wpinv_item_types() ),
-						'type' => 'string',
-					),
-				),
-
-			)
-		);
-
-		// Filter collection parameters for the items controller.
-		return apply_filters( 'getpaid_rest_items_collection_params', $params, $this );
-
-	}
-
-	/**
-	 * Determine the allowed query_vars for a get_items() response and
-	 * prepare for WP_Query.
-	 *
-	 * @param array           $prepared_args Prepared arguments.
-	 * @param WP_REST_Request $request Request object.
-	 * @return array          $query_args
-	 */
-	protected function prepare_items_query( $prepared_args = array(), $request = null ) {
-
-		$query_args = parent::prepare_items_query( $prepared_args );
-
-		// Retrieve items by type.
-		if ( ! in_array( 'any', $request['type'] ) ) {
-
-			if ( empty( $query_args['meta_query'] ) ) {
-				$query_args['meta_query'] = array();
-			}
-
-			$query_args['meta_query'][] = array(
-				'key'     => '_wpinv_type',
-				'value'   => implode( ',', $request['type'] ),
-				'compare' => 'IN',
-			);
-
-		}
-
-		return apply_filters( 'getpaid_rest_items_prepare_items_query', $query_args, $request, $this );
-
-	}
-
-	/**
-	 * Retrieves a valid list of post statuses.
-	 *
-	 * @since 1.0.15
-	 *
-	 * @return array A list of registered item statuses.
-	 */
-	public function get_post_statuses() {
-		return array( 'draft', 'pending', 'publish' );
-	}
-
-	/**
-	 * Checks if a key should be included in a response.
-	 *
-	 * @since  1.0.19
-	 * @param  WPInv_Item   $item  Item object.
-	 * @param  string       $field_key The key to check for.
-	 * @return bool
-	 */
-	public function object_supports_field( $item, $field_key ) {
-
-		if ( 'minimum_price' == $field_key && ! $item->user_can_set_their_price() ) {
-			return false;
-		}
-
-		foreach ( wpinv_parse_list( 'initial_price the_initial_price recurring_price the_recurring_price recurring_period recurring_interval recurring_limit is_free_trial trial_period trial_interval first_renewal_date' ) as $key ) {
-
-			if ( $key == $field_key && ! $item->is_recurring() ) {
-				return false;
-			}
+     * The base of this controller's route.
+     *
+     * @since 1.0.13
+     * @var string
+     */
+    protected $rest_base = 'items';
+
+    /** Contains this controller's class name.
+     *
+     * @var string
+     */
+    public $crud_class = 'WPInv_Item';
+
+    /**
+     * Registers the routes for the objects of the controller.
+     *
+     * @since 1.0.19
+     *
+     * @see register_rest_route()
+     */
+    public function register_namespace_routes( $namespace ) {
+
+        parent::register_namespace_routes( $namespace );
+
+        register_rest_route(
+            $this->namespace,
+            '/' . $this->rest_base . '/item-types',
+            array(
+                array(
+                    'methods'             => WP_REST_Server::READABLE,
+                    'callback'            => array( $this, 'get_item_types' ),
+                    'permission_callback' => array( $this, 'get_items_permissions_check' ),
+                ),
+            )
+        );
+
+    }
+
+    /**
+     * Handles rest requests for item types.
+     *
+     * @since 1.0.13
+     *
+     *
+     * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
+     */
+    public function get_item_types() {
+        return rest_ensure_response( wpinv_get_item_types() );
+    }
+
+    /**
+     * Retrieves the query params for the items collection.
+     *
+     * @since 1.0.13
+     *
+     * @return array Collection parameters.
+     */
+    public function get_collection_params() {
+
+        $params = array_merge(
+            parent::get_collection_params(),
+            array(
+
+                // Item types
+                'type' => array(
+                    'description'       => __( 'Type of items to fetch.', 'invoicing' ),
+                    'type'              => array( 'array', 'string' ),
+                    'default'           => 'any',
+                    'validate_callback' => 'rest_validate_request_arg',
+                    'sanitize_callback' => 'wpinv_parse_list',
+                    'items'             => array(
+                        'enum' => array_merge( array( 'any' ), wpinv_item_types() ),
+                        'type' => 'string',
+                    ),
+                ),
+
+            )
+        );
+
+        // Filter collection parameters for the items controller.
+        return apply_filters( 'getpaid_rest_items_collection_params', $params, $this );
+
+    }
+
+    /**
+     * Determine the allowed query_vars for a get_items() response and
+     * prepare for WP_Query.
+     *
+     * @param array           $prepared_args Prepared arguments.
+     * @param WP_REST_Request $request Request object.
+     * @return array          $query_args
+     */
+    protected function prepare_items_query( $prepared_args = array(), $request = null ) {
+
+        $query_args = parent::prepare_items_query( $prepared_args );
+
+        // Retrieve items by type.
+        if ( ! in_array( 'any', $request['type'] ) ) {
+
+            if ( empty( $query_args['meta_query'] ) ) {
+                $query_args['meta_query'] = array();
+            }
+
+            $query_args['meta_query'][] = array(
+                'key'     => '_wpinv_type',
+                'value'   => implode( ',', $request['type'] ),
+                'compare' => 'IN',
+            );
+
+        }
+
+        return apply_filters( 'getpaid_rest_items_prepare_items_query', $query_args, $request, $this );
+
+    }
+
+    /**
+     * Retrieves a valid list of post statuses.
+     *
+     * @since 1.0.15
+     *
+     * @return array A list of registered item statuses.
+     */
+    public function get_post_statuses() {
+        return array( 'draft', 'pending', 'publish' );
+    }
+
+    /**
+     * Checks if a key should be included in a response.
+     *
+     * @since  1.0.19
+     * @param  WPInv_Item   $item  Item object.
+     * @param  string       $field_key The key to check for.
+     * @return bool
+     */
+    public function object_supports_field( $item, $field_key ) {
+
+        if ( 'minimum_price' == $field_key && ! $item->user_can_set_their_price() ) {
+            return false;
+        }
+
+        foreach ( wpinv_parse_list( 'initial_price the_initial_price recurring_price the_recurring_price recurring_period recurring_interval recurring_limit is_free_trial trial_period trial_interval first_renewal_date' ) as $key ) {
+
+            if ( $key == $field_key && ! $item->is_recurring() ) {
+                return false;
+            }
 }
 
-		foreach ( wpinv_parse_list( 'trial_period trial_interval' ) as $key ) {
+        foreach ( wpinv_parse_list( 'trial_period trial_interval' ) as $key ) {
 
-			if ( $key == $field_key && ! $item->has_free_trial() ) {
-				return false;
-			}
+            if ( $key == $field_key && ! $item->has_free_trial() ) {
+                return false;
+            }
 }
 
-		return parent::object_supports_field( $item, $field_key );
-	}
+        return parent::object_supports_field( $item, $field_key );
+    }
 
 }

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

Indentation +129 added lines, -129 removed lines

@@ -15,136 +15,136 @@
 class WPInv_REST_Discounts_Controller extends GetPaid_REST_Posts_Controller {
 
     /**
-	 * Post type.
-	 *
-	 * @var string
-	 */
-	protected $post_type = 'wpi_discount';
-
-	/**
-	 * The base of this controller's route.
-	 *
-	 * @since 1.0.13
-	 * @var string
-	 */
-	protected $rest_base = 'discounts';
-
-	/** Contains this controller's class name.
-	 *
-	 * @var string
-	 */
-	public $crud_class = 'WPInv_Discount';
-
-	/**
-	 * Registers the routes for the objects of the controller.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @see register_rest_route()
-	 */
-	public function register_namespace_routes( $namespace ) {
-
-		parent::register_namespace_routes( $namespace );
-
-		register_rest_route(
-			$this->namespace,
-			'/' . $this->rest_base . '/discount-types',
-			array(
-				array(
-					'methods'             => WP_REST_Server::READABLE,
-					'callback'            => array( $this, 'get_discount_types' ),
-					'permission_callback' => array( $this, 'get_items_permissions_check' ),
-				),
-			)
-		);
-
-	}
-
-	/**
-	 * Handles rest requests for discount types.
-	 *
-	 * @since 1.0.13
-	 *
-	 *
-	 * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
-	 */
-	public function get_discount_types() {
-		return rest_ensure_response( wpinv_get_discount_types() );
-	}
+     * Post type.
+     *
+     * @var string
+     */
+    protected $post_type = 'wpi_discount';
 
     /**
-	 * Retrieves the query params for the discount collection.
-	 *
-	 * @since 1.0.13
-	 *
-	 * @return array Collection parameters.
-	 */
-	public function get_collection_params() {
-
-		$params = array_merge(
-			parent::get_collection_params(),
-        	array(
-
-				// Discount types
-				'type' => array(
-					'description'       => __( 'Type of discounts to fetch.', 'invoicing' ),
-					'type'              => array( 'array', 'string' ),
-					'default'           => 'any',
-					'validate_callback' => 'rest_validate_request_arg',
-					'sanitize_callback' => 'wpinv_parse_list',
-					'items'             => array(
-						'enum' => array_merge( array( 'any' ), array_keys( wpinv_get_discount_types() ) ),
-						'type' => 'string',
-					),
-				),
-
-			)
-		);
-
-		// Filter collection parameters for the discounts controller.
-		return apply_filters( 'getpaid_rest_discounts_collection_params', $params, $this );
-	}
-
-	/**
-	 * Determine the allowed query_vars for a get_items() response and
-	 * prepare for WP_Query.
-	 *
-	 * @param array           $prepared_args Prepared arguments.
-	 * @param WP_REST_Request $request Request object.
-	 * @return array          $query_args
-	 */
-	protected function prepare_items_query( $prepared_args = array(), $request = null ) {
-
-		$query_args = parent::prepare_items_query( $prepared_args );
-
-		// Retrieve items by type.
-		if ( ! in_array( 'any', $request['type'] ) ) {
-
-			if ( empty( $query_args['meta_query'] ) ) {
-				$query_args['meta_query'] = array();
-			}
-
-			$query_args['meta_query'][] = array(
-				'key'     => '_wpi_discount_type',
-				'value'   => implode( ',', $request['type'] ),
-				'compare' => 'IN',
-			);
-
-		}
-
-		return apply_filters( 'getpaid_rest_discounts_prepare_items_query', $query_args, $request, $this );
-
-	}
-
-	/**
-	 * Retrieves a valid list of post statuses.
-	 *
-	 * @since 1.0.15
-	 *
-	 * @return array A list of registered item statuses.
-	 */
-	public function get_post_statuses() {
-		return array( 'publish', 'pending', 'draft', 'expired' );
-	}
+     * The base of this controller's route.
+     *
+     * @since 1.0.13
+     * @var string
+     */
+    protected $rest_base = 'discounts';
+
+    /** Contains this controller's class name.
+     *
+     * @var string
+     */
+    public $crud_class = 'WPInv_Discount';
+
+    /**
+     * Registers the routes for the objects of the controller.
+     *
+     * @since 1.0.19
+     *
+     * @see register_rest_route()
+     */
+    public function register_namespace_routes( $namespace ) {
+
+        parent::register_namespace_routes( $namespace );
+
+        register_rest_route(
+            $this->namespace,
+            '/' . $this->rest_base . '/discount-types',
+            array(
+                array(
+                    'methods'             => WP_REST_Server::READABLE,
+                    'callback'            => array( $this, 'get_discount_types' ),
+                    'permission_callback' => array( $this, 'get_items_permissions_check' ),
+                ),
+            )
+        );
+
+    }
+
+    /**
+     * Handles rest requests for discount types.
+     *
+     * @since 1.0.13
+     *
+     *
+     * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
+     */
+    public function get_discount_types() {
+        return rest_ensure_response( wpinv_get_discount_types() );
+    }
+
+    /**
+     * Retrieves the query params for the discount collection.
+     *
+     * @since 1.0.13
+     *
+     * @return array Collection parameters.
+     */
+    public function get_collection_params() {
+
+        $params = array_merge(
+            parent::get_collection_params(),
+            array(
+
+                // Discount types
+                'type' => array(
+                    'description'       => __( 'Type of discounts to fetch.', 'invoicing' ),
+                    'type'              => array( 'array', 'string' ),
+                    'default'           => 'any',
+                    'validate_callback' => 'rest_validate_request_arg',
+                    'sanitize_callback' => 'wpinv_parse_list',
+                    'items'             => array(
+                        'enum' => array_merge( array( 'any' ), array_keys( wpinv_get_discount_types() ) ),
+                        'type' => 'string',
+                    ),
+                ),
+
+            )
+        );
+
+        // Filter collection parameters for the discounts controller.
+        return apply_filters( 'getpaid_rest_discounts_collection_params', $params, $this );
+    }
+
+    /**
+     * Determine the allowed query_vars for a get_items() response and
+     * prepare for WP_Query.
+     *
+     * @param array           $prepared_args Prepared arguments.
+     * @param WP_REST_Request $request Request object.
+     * @return array          $query_args
+     */
+    protected function prepare_items_query( $prepared_args = array(), $request = null ) {
+
+        $query_args = parent::prepare_items_query( $prepared_args );
+
+        // Retrieve items by type.
+        if ( ! in_array( 'any', $request['type'] ) ) {
+
+            if ( empty( $query_args['meta_query'] ) ) {
+                $query_args['meta_query'] = array();
+            }
+
+            $query_args['meta_query'][] = array(
+                'key'     => '_wpi_discount_type',
+                'value'   => implode( ',', $request['type'] ),
+                'compare' => 'IN',
+            );
+
+        }
+
+        return apply_filters( 'getpaid_rest_discounts_prepare_items_query', $query_args, $request, $this );
+
+    }
+
+    /**
+     * Retrieves a valid list of post statuses.
+     *
+     * @since 1.0.15
+     *
+     * @return array A list of registered item statuses.
+     */
+    public function get_post_statuses() {
+        return array( 'publish', 'pending', 'draft', 'expired' );
+    }
 
 }