AyeCode / invoicing

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

Indentation +743 added lines, -743 removed lines

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

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-getpaid-rest-report-sales-controller.php

Indentation +660 added lines, -660 removed lines

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

includes/api/class-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' );
+    }
 
 }

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

Indentation +465 added lines, -465 removed lines

@@ -17,474 +17,474 @@
  */
 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;
-				}
-			}
+    /**
+     * 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;
-			}
+        // 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 );
-	}
+        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 );
+    }
 
 }

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

Indentation +573 added lines, -573 removed lines

@@ -16,577 +16,577 @@
  */
 class GetPaid_REST_Date_Based_Controller extends GetPaid_REST_Controller {
 
-	/**
-	 * Group response items by day or month.
-	 *
-	 * @var string
-	 */
-	public $groupby = 'day';
-
-	/**
-	 * Returns an array with arguments to request the previous report.
-	 *
-	 * @var array
-	 */
-	public $previous_range = array();
-
-	/**
-	 * The period interval.
-	 *
-	 * @var int
-	 */
-	public $interval;
-
-	/**
-	 * Retrieves the before and after dates.
-	 *
-	 * @param WP_REST_Request $request Request object.
-	 * @return array The appropriate date range.
-	 */
-	public function get_date_range( $request ) {
-
-		// If not supported, assume all time.
-		if ( ! in_array( $request['period'], array( 'custom', 'today', 'yesterday', 'week', 'last_week', '7_days', '30_days', '60_days', '90_days', '180_days', 'month', 'last_month', 'quarter', 'last_quarter', 'year', 'last_year' ) ) ) {
-			$request['period'] = '7_days';
-		}
-
-		$date_range = call_user_func( array( $this, 'get_' . $request['period'] . '_date_range' ), $request );
-		$this->prepare_interval( $date_range );
-
-		return $date_range;
-
-	}
-
-	/**
-	 * Groups by month or days.
-	 *
-	 * @param array $range Date range.
-	 * @return array The appropriate date range.
-	 */
-	public function prepare_interval( $range ) {
-
-		$before = strtotime( $range['before'] ) - DAY_IN_SECONDS;
-		$after  = strtotime( $range['after'] ) + DAY_IN_SECONDS;
-		if ( 'day' === $this->groupby ) {
-			$difference     = max( DAY_IN_SECONDS, ( DAY_IN_SECONDS + $before - $after ) ); // Prevent division by 0;
-			$this->interval = absint( ceil( max( 1, $difference / DAY_IN_SECONDS ) ) );
-			return;
-		}
-
-		$this->interval = 0;
-		$min_date       = strtotime( date( 'Y-m-01', $after ) );
-
-		while ( $min_date <= $before ) {
-			$this->interval ++;
-			$min_date = strtotime( '+1 MONTH', $min_date );
-		}
-
-		$this->interval = max( 1, $this->interval );
-
-	}
-
-	/**
-	 * Retrieves a custom date range.
-	 *
-	 * @param WP_REST_Request $request Request object.
-	 * @return array The appropriate date range.
-	 */
-	public function get_custom_date_range( $request ) {
-
-		$after  = max( strtotime( '-20 years' ), strtotime( sanitize_text_field( $request['after'] ) ) );
-		$before = strtotime( '+1 day', current_time( 'timestamp' ) );
-
-		if ( ! empty( $request['before'] ) ) {
-			$before  = min( $before, strtotime( sanitize_text_field( $request['before'] ) ) );
-		}
-
-		// 3 months max for day view
-		if ( floor( ( $before - $after ) / MONTH_IN_SECONDS ) > 3 ) {
-			$this->groupby = 'month';
-		}
-
-		// Set the previous date range.
-		$difference           = $before - $after;
-		$this->previous_range = array(
-			'period' => 'custom',
-			'before' => date( 'Y-m-d', $before - $difference ),
-			'after'  => date( 'Y-m-d', $after - $difference ),
-		);
-
-		// Generate the report.
-		return array(
-			'before' => date( 'Y-m-d', $before ),
-			'after'  => date( 'Y-m-d', $after ),
-		);
-
-	}
-
-	/**
-	 * Retrieves todays date range.
-	 *
-	 * @return array The appropriate date range.
-	 */
-	public function get_today_date_range() {
-
-		// Set the previous date range.
-		$this->previous_range = array(
-			'period' => 'yesterday',
-		);
-
-		// Generate the report.
-		return array(
-			'before' => date( 'Y-m-d', strtotime( '+1 day', current_time( 'timestamp' ) ) ),
-			'after'  => date( 'Y-m-d', strtotime( '-1 day', current_time( 'timestamp' ) ) ),
-		);
-
-	}
-
-	/**
-	 * Retrieves yesterdays date range.
-	 *
-	 * @return array The appropriate date range.
-	 */
-	public function get_yesterday_date_range() {
-
-		// Set the previous date range.
-		$this->previous_range = array(
-			'period' => 'custom',
-			'before' => date( 'Y-m-d', strtotime( '-1 day', current_time( 'timestamp' ) ) ),
-			'after'  => date( 'Y-m-d', strtotime( '-3 days', current_time( 'timestamp' ) ) ),
-		);
-
-		// Generate the report.
-		return array(
-			'before' => date( 'Y-m-d', current_time( 'timestamp' ) ),
-			'after'  => date( 'Y-m-d', strtotime( '-2 days', current_time( 'timestamp' ) ) ),
-		);
-
-	}
-
-	/**
-	 * Retrieves this week's date range.
-	 *
-	 * @return array The appropriate date range.
-	 */
-	public function get_week_date_range() {
-
-		// Set the previous date range.
-		$this->previous_range = array(
-			'period' => 'last_week',
-		);
-
-		// Generate the report.
-		return array(
-			'before' => date( 'Y-m-d', strtotime( 'sunday last week', current_time( 'timestamp' ) ) + 8 * DAY_IN_SECONDS ),
-			'after'  => date( 'Y-m-d', strtotime( 'sunday last week', current_time( 'timestamp' ) ) ),
-		);
-
-	}
-
-	/**
-	 * Retrieves last week's date range.
-	 *
-	 * @return array The appropriate date range.
-	 */
-	public function get_last_week_date_range() {
-
-		// Set the previous date range.
-		$this->previous_range = array(
-			'period' => 'custom',
-			'before' => date( 'Y-m-d', strtotime( 'monday last week', current_time( 'timestamp' ) ) ),
-			'after'  => date( 'Y-m-d', strtotime( 'monday last week', current_time( 'timestamp' ) ) - 8 * DAY_IN_SECONDS ),
-		);
-
-		// Generate the report.
-		return array(
-			'before' => date( 'Y-m-d', strtotime( 'monday this week', current_time( 'timestamp' ) ) ),
-			'after'  => date( 'Y-m-d', strtotime( 'monday last week', current_time( 'timestamp' ) ) - DAY_IN_SECONDS ),
-		);
-
-	}
-
-	/**
-	 * Retrieves last 7 days date range.
-	 *
-	 * @return array The appropriate date range.
-	 */
-	public function get_7_days_date_range() {
-
-		// Set the previous date range.
-		$this->previous_range = array(
-			'period' => 'custom',
-			'before' => date( 'Y-m-d', strtotime( '-7 days', current_time( 'timestamp' ) ) ),
-			'after'  => date( 'Y-m-d', strtotime( '-15 days', current_time( 'timestamp' ) ) ),
-		);
-
-		// Generate the report.
-		return array(
-			'before' => date( 'Y-m-d', current_time( 'timestamp' ) ),
-			'after'  => date( 'Y-m-d', strtotime( '-8 days', current_time( 'timestamp' ) ) ),
-		);
-
-	}
-
-	/**
-	 * Retrieves last 30 days date range.
-	 *
-	 * @return array The appropriate date range.
-	 */
-	public function get_30_days_date_range() {
-
-		// Set the previous date range.
-		$this->previous_range = array(
-			'period' => 'custom',
-			'before' => date( 'Y-m-d', strtotime( '-30 days', current_time( 'timestamp' ) ) ),
-			'after'  => date( 'Y-m-d', strtotime( '-61 days', current_time( 'timestamp' ) ) ),
-		);
-
-		// Generate the report.
-		return array(
-			'before' => date( 'Y-m-d', current_time( 'timestamp' ) ),
-			'after'  => date( 'Y-m-d', strtotime( '-31 days', current_time( 'timestamp' ) ) ),
-		);
-
-	}
-
-	/**
-	 * Retrieves last 90 days date range.
-	 *
-	 * @return array The appropriate date range.
-	 */
-	public function get_90_days_date_range() {
-
-		$this->groupby = 'month';
-
-		// Set the previous date range.
-		$this->previous_range = array(
-			'period' => 'custom',
-			'before' => date( 'Y-m-d', strtotime( '-90 days', current_time( 'timestamp' ) ) ),
-			'after'  => date( 'Y-m-d', strtotime( '-181 days', current_time( 'timestamp' ) ) ),
-		);
-
-		// Generate the report.
-		return array(
-			'before' => date( 'Y-m-d', current_time( 'timestamp' ) ),
-			'after'  => date( 'Y-m-d', strtotime( '-91 days', current_time( 'timestamp' ) ) ),
-		);
-
-	}
-
-	/**
-	 * Retrieves last 180 days date range.
-	 *
-	 * @return array The appropriate date range.
-	 */
-	public function get_180_days_date_range() {
-
-		$this->groupby = 'month';
-
-		// Set the previous date range.
-		$this->previous_range = array(
-			'period' => 'custom',
-			'before' => date( 'Y-m-d', strtotime( '-180 days', current_time( 'timestamp' ) ) ),
-			'after'  => date( 'Y-m-d', strtotime( '-361 days', current_time( 'timestamp' ) ) ),
-		);
-
-		// Generate the report.
-		return array(
-			'before' => date( 'Y-m-d', current_time( 'timestamp' ) ),
-			'after'  => date( 'Y-m-d', strtotime( '-181 days', current_time( 'timestamp' ) ) ),
-		);
-
-	}
-
-	/**
-	 * Retrieves last 60 days date range.
-	 *
-	 * @return array The appropriate date range.
-	 */
-	public function get_60_days_date_range() {
-
-		// Set the previous date range.
-		$this->previous_range = array(
-			'period' => 'custom',
-			'before' => date( 'Y-m-d', strtotime( '-60 days', current_time( 'timestamp' ) ) ),
-			'after'  => date( 'Y-m-d', strtotime( '-121 days', current_time( 'timestamp' ) ) ),
-		);
-
-		// Generate the report.
-		return array(
-			'before' => date( 'Y-m-d', current_time( 'timestamp' ) ),
-			'after'  => date( 'Y-m-d', strtotime( '-61 days', current_time( 'timestamp' ) ) ),
-		);
-
-	}
-
-	/**
-	 * Retrieves this month date range.
-	 *
-	 * @return array The appropriate date range.
-	 */
-	public function get_month_date_range() {
-
-		// Set the previous date range.
-		$this->previous_range = array(
-			'period' => 'last_month',
-		);
-
-		// Generate the report.
-		return array(
-			'before' => date( 'Y-m-01', strtotime( 'next month', current_time( 'timestamp' ) ) ),
-			'after'  => date( 'Y-m-t', strtotime( 'last month', current_time( 'timestamp' ) ) ),
-		);
-
-	}
-
-	/**
-	 * Retrieves last month's date range.
-	 *
-	 * @return array The appropriate date range.
-	 */
-	public function get_last_month_date_range() {
-
-		// Set the previous date range.
-		$this->previous_range = array(
-			'period' => 'custom',
-			'before' => date( 'Y-m-1', strtotime( 'last month', current_time( 'timestamp' ) ) ),
-			'after'  => date( 'Y-m-t', strtotime( '-3 months', current_time( 'timestamp' ) ) ),
-		);
-
-		// Generate the report.
-		return array(
-			'before' => date( 'Y-m-1', current_time( 'timestamp' ) ),
-			'after'  => date( 'Y-m-t', strtotime( '-2 months', current_time( 'timestamp' ) ) ),
-		);
-
-	}
-
-	/**
-	 * Retrieves this quarter date range.
-	 *
-	 * @return array The available quarters.
-	 */
-	public function get_quarters() {
-
-		$last_year = (int) date( 'Y' ) - 1;
-		$next_year = (int) date( 'Y' ) + 1;
-		$year      = (int) date( 'Y' );
-		return array(
-
-			array(
-				'after'  => "$last_year-06-30",
-				'before' => "$last_year-10-01",
-			),
-
-			array(
-				'before' => "$year-01-01",
-				'after'  => "$last_year-09-30",
-			),
-
-			array(
-				'before' => "$year-04-01",
-				'after'  => "$last_year-12-31",
-			),
-
-			array(
-				'before' => "$year-07-01",
-				'after'  => "$year-03-31",
-			),
-
-			array(
-				'after'  => "$year-06-30",
-				'before' => "$year-10-01",
-			),
-
-			array(
-				'before' => "$next_year-01-01",
-				'after'  => "$year-09-30",
-			),
-
-		);
-
-	}
-
-	/**
-	 * Retrieves the current quater.
-	 *
-	 * @return int The current quarter.
-	 */
-	public function get_quarter() {
-
-		$month    = (int) date( 'n', current_time( 'timestamp' ) );
-		$quarters = array( 1, 1, 1, 2, 2, 2, 3, 3, 3, 4, 4, 4 );
-		return $quarters[ $month - 1 ];
-
-	}
-
-	/**
-	 * Retrieves this quarter date range.
-	 *
-	 * @return array The appropriate date range.
-	 */
-	public function get_quarter_date_range() {
-
-		// Set the previous date range.
-		$this->previous_range = array(
-			'period' => 'last_quarter',
-		);
-
-		// Generate the report.
-		$quarters = $this->get_quarters();
-		return $quarters[ $this->get_quarter() + 1 ];
-
-	}
-
-	/**
-	 * Retrieves last quarter's date range.
-	 *
-	 * @return array The appropriate date range.
-	 */
-	public function get_last_quarter_date_range() {
-
-		$quarters = $this->get_quarters();
-		$quarter  = $this->get_quarter();
-
-		// Set the previous date range.
-		$this->previous_range = array_merge(
-			$quarters[ $quarter - 1 ],
-			array( 'period' => 'custom' )
-		);
-
-		// Generate the report.
-		return $quarters[ $quarter ];
-
-	}
-
-	/**
-	 * Retrieves this year date range.
-	 *
-	 * @return array The appropriate date range.
-	 */
-	public function get_year_date_range() {
-
-		$this->groupby = 'month';
-
-		// Set the previous date range.
-		$this->previous_range = array(
-			'period' => 'last_year',
-		);
-
-		// Generate the report.
-		return array(
-			'before' => date( 'Y-m-d', strtotime( 'next year January 1st', current_time( 'timestamp' ) ) ),
-			'after'  => date( 'Y-m-d', strtotime( 'last year December 31st', current_time( 'timestamp' ) ) ),
-		);
-
-	}
-
-	/**
-	 * Retrieves last year date range.
-	 *
-	 * @return array The appropriate date range.
-	 */
-	public function get_last_year_date_range() {
-
-		$this->groupby = 'month';
-
-		// Set the previous date range.
-		$year          = (int) date( 'Y' ) - 3;
-		$this->previous_range = array(
-			'period' => 'custom',
-			'before' => date( 'Y-m-d', strtotime( 'first day of january last year', current_time( 'timestamp' ) ) ),
-			'after'  => "$year-12-31",
-		);
-
-		// Generate the report.
-		$year          = (int) date( 'Y' ) - 2;
-		return array(
-			'after'  => "$year-12-31",
-			'before' => date( 'Y-m-d', strtotime( 'first day of january this year', current_time( 'timestamp' ) ) ),
-		);
-
-	}
-
-	/**
-	 * Prepare a the request date for SQL usage.
-	 *
-	 * @param WP_REST_Request $request Request object.
-	 * @param string $date_field The date field.
-	 * @return string The appropriate SQL.
-	 */
-	public function get_date_range_sql( $request, $date_field ) {
-		global $wpdb;
-
-		$sql = '1=1';
-		$range = $this->get_date_range( $request );
-
-		if ( ! empty( $range['after'] ) ) {
-			$sql .= ' AND ' . $wpdb->prepare(
-				"$date_field > %s",
-				$range['after']
-			);
-		}
-
-		if ( ! empty( $range['before'] ) ) {
-			$sql .= ' AND ' . $wpdb->prepare(
-				"$date_field < %s",
-				$range['before']
-			);
-		}
-
-		return $sql;
-
-	}
-
-	/**
-	 * Prepares a group by query.
-	 *
-	 * @param string $date_field The date field.
-	 * @return string The appropriate SQL.
-	 */
-	public function get_group_by_sql( $date_field ) {
-
-		if ( 'day' === $this->groupby ) {
-			return "YEAR($date_field), MONTH($date_field), DAY($date_field)";
-		}
-
-		return "YEAR($date_field), MONTH($date_field)";
-	}
-
-	/**
-	 * Get the query params for collections.
-	 *
-	 * @return array
-	 */
-	public function get_collection_params() {
-		return array(
-			'context' => $this->get_context_param( array( 'default' => 'view' ) ),
-			'period'  => array(
-				'description'       => __( 'Limit to results of a specific period.', 'invoicing' ),
-				'type'              => 'string',
-				'enum'              => array( 'custom', 'today', 'yesterday', 'week', 'last_week', '7_days', '30_days', '60_days', '90_days', '180_days', 'month', 'last_month', 'quarter', 'last_quarter', 'year', 'last_year', 'quarter', 'last_quarter' ),
-				'validate_callback' => 'rest_validate_request_arg',
-				'sanitize_callback' => 'sanitize_text_field',
-				'default'           => '7_days',
-			),
-			'after'   => array(
-				/* translators: %s: date format */
-				'description'       => sprintf( __( 'Limit to results after a specific date, the date needs to be in the %s format.', 'invoicing' ), 'YYYY-MM-DD' ),
-				'type'              => 'string',
-				'format'            => 'date',
-				'validate_callback' => 'rest_validate_request_arg',
-				'sanitize_callback' => 'sanitize_text_field',
-				'default'           => date( 'Y-m-d', strtotime( '-8 days', current_time( 'timestamp' ) ) ),
-			),
-			'before'  => array(
-				/* translators: %s: date format */
-				'description'       => sprintf( __( 'Limit to results before a specific date, the date needs to be in the %s format.', 'invoicing' ), 'YYYY-MM-DD' ),
-				'type'              => 'string',
-				'format'            => 'date',
-				'validate_callback' => 'rest_validate_request_arg',
-				'sanitize_callback' => 'sanitize_text_field',
-				'default'           => date( 'Y-m-d', current_time( 'timestamp' ) ),
-			),
-		);
-	}
+    /**
+     * Group response items by day or month.
+     *
+     * @var string
+     */
+    public $groupby = 'day';
+
+    /**
+     * Returns an array with arguments to request the previous report.
+     *
+     * @var array
+     */
+    public $previous_range = array();
+
+    /**
+     * The period interval.
+     *
+     * @var int
+     */
+    public $interval;
+
+    /**
+     * Retrieves the before and after dates.
+     *
+     * @param WP_REST_Request $request Request object.
+     * @return array The appropriate date range.
+     */
+    public function get_date_range( $request ) {
+
+        // If not supported, assume all time.
+        if ( ! in_array( $request['period'], array( 'custom', 'today', 'yesterday', 'week', 'last_week', '7_days', '30_days', '60_days', '90_days', '180_days', 'month', 'last_month', 'quarter', 'last_quarter', 'year', 'last_year' ) ) ) {
+            $request['period'] = '7_days';
+        }
+
+        $date_range = call_user_func( array( $this, 'get_' . $request['period'] . '_date_range' ), $request );
+        $this->prepare_interval( $date_range );
+
+        return $date_range;
+
+    }
+
+    /**
+     * Groups by month or days.
+     *
+     * @param array $range Date range.
+     * @return array The appropriate date range.
+     */
+    public function prepare_interval( $range ) {
+
+        $before = strtotime( $range['before'] ) - DAY_IN_SECONDS;
+        $after  = strtotime( $range['after'] ) + DAY_IN_SECONDS;
+        if ( 'day' === $this->groupby ) {
+            $difference     = max( DAY_IN_SECONDS, ( DAY_IN_SECONDS + $before - $after ) ); // Prevent division by 0;
+            $this->interval = absint( ceil( max( 1, $difference / DAY_IN_SECONDS ) ) );
+            return;
+        }
+
+        $this->interval = 0;
+        $min_date       = strtotime( date( 'Y-m-01', $after ) );
+
+        while ( $min_date <= $before ) {
+            $this->interval ++;
+            $min_date = strtotime( '+1 MONTH', $min_date );
+        }
+
+        $this->interval = max( 1, $this->interval );
+
+    }
+
+    /**
+     * Retrieves a custom date range.
+     *
+     * @param WP_REST_Request $request Request object.
+     * @return array The appropriate date range.
+     */
+    public function get_custom_date_range( $request ) {
+
+        $after  = max( strtotime( '-20 years' ), strtotime( sanitize_text_field( $request['after'] ) ) );
+        $before = strtotime( '+1 day', current_time( 'timestamp' ) );
+
+        if ( ! empty( $request['before'] ) ) {
+            $before  = min( $before, strtotime( sanitize_text_field( $request['before'] ) ) );
+        }
+
+        // 3 months max for day view
+        if ( floor( ( $before - $after ) / MONTH_IN_SECONDS ) > 3 ) {
+            $this->groupby = 'month';
+        }
+
+        // Set the previous date range.
+        $difference           = $before - $after;
+        $this->previous_range = array(
+            'period' => 'custom',
+            'before' => date( 'Y-m-d', $before - $difference ),
+            'after'  => date( 'Y-m-d', $after - $difference ),
+        );
+
+        // Generate the report.
+        return array(
+            'before' => date( 'Y-m-d', $before ),
+            'after'  => date( 'Y-m-d', $after ),
+        );
+
+    }
+
+    /**
+     * Retrieves todays date range.
+     *
+     * @return array The appropriate date range.
+     */
+    public function get_today_date_range() {
+
+        // Set the previous date range.
+        $this->previous_range = array(
+            'period' => 'yesterday',
+        );
+
+        // Generate the report.
+        return array(
+            'before' => date( 'Y-m-d', strtotime( '+1 day', current_time( 'timestamp' ) ) ),
+            'after'  => date( 'Y-m-d', strtotime( '-1 day', current_time( 'timestamp' ) ) ),
+        );
+
+    }
+
+    /**
+     * Retrieves yesterdays date range.
+     *
+     * @return array The appropriate date range.
+     */
+    public function get_yesterday_date_range() {
+
+        // Set the previous date range.
+        $this->previous_range = array(
+            'period' => 'custom',
+            'before' => date( 'Y-m-d', strtotime( '-1 day', current_time( 'timestamp' ) ) ),
+            'after'  => date( 'Y-m-d', strtotime( '-3 days', current_time( 'timestamp' ) ) ),
+        );
+
+        // Generate the report.
+        return array(
+            'before' => date( 'Y-m-d', current_time( 'timestamp' ) ),
+            'after'  => date( 'Y-m-d', strtotime( '-2 days', current_time( 'timestamp' ) ) ),
+        );
+
+    }
+
+    /**
+     * Retrieves this week's date range.
+     *
+     * @return array The appropriate date range.
+     */
+    public function get_week_date_range() {
+
+        // Set the previous date range.
+        $this->previous_range = array(
+            'period' => 'last_week',
+        );
+
+        // Generate the report.
+        return array(
+            'before' => date( 'Y-m-d', strtotime( 'sunday last week', current_time( 'timestamp' ) ) + 8 * DAY_IN_SECONDS ),
+            'after'  => date( 'Y-m-d', strtotime( 'sunday last week', current_time( 'timestamp' ) ) ),
+        );
+
+    }
+
+    /**
+     * Retrieves last week's date range.
+     *
+     * @return array The appropriate date range.
+     */
+    public function get_last_week_date_range() {
+
+        // Set the previous date range.
+        $this->previous_range = array(
+            'period' => 'custom',
+            'before' => date( 'Y-m-d', strtotime( 'monday last week', current_time( 'timestamp' ) ) ),
+            'after'  => date( 'Y-m-d', strtotime( 'monday last week', current_time( 'timestamp' ) ) - 8 * DAY_IN_SECONDS ),
+        );
+
+        // Generate the report.
+        return array(
+            'before' => date( 'Y-m-d', strtotime( 'monday this week', current_time( 'timestamp' ) ) ),
+            'after'  => date( 'Y-m-d', strtotime( 'monday last week', current_time( 'timestamp' ) ) - DAY_IN_SECONDS ),
+        );
+
+    }
+
+    /**
+     * Retrieves last 7 days date range.
+     *
+     * @return array The appropriate date range.
+     */
+    public function get_7_days_date_range() {
+
+        // Set the previous date range.
+        $this->previous_range = array(
+            'period' => 'custom',
+            'before' => date( 'Y-m-d', strtotime( '-7 days', current_time( 'timestamp' ) ) ),
+            'after'  => date( 'Y-m-d', strtotime( '-15 days', current_time( 'timestamp' ) ) ),
+        );
+
+        // Generate the report.
+        return array(
+            'before' => date( 'Y-m-d', current_time( 'timestamp' ) ),
+            'after'  => date( 'Y-m-d', strtotime( '-8 days', current_time( 'timestamp' ) ) ),
+        );
+
+    }
+
+    /**
+     * Retrieves last 30 days date range.
+     *
+     * @return array The appropriate date range.
+     */
+    public function get_30_days_date_range() {
+
+        // Set the previous date range.
+        $this->previous_range = array(
+            'period' => 'custom',
+            'before' => date( 'Y-m-d', strtotime( '-30 days', current_time( 'timestamp' ) ) ),
+            'after'  => date( 'Y-m-d', strtotime( '-61 days', current_time( 'timestamp' ) ) ),
+        );
+
+        // Generate the report.
+        return array(
+            'before' => date( 'Y-m-d', current_time( 'timestamp' ) ),
+            'after'  => date( 'Y-m-d', strtotime( '-31 days', current_time( 'timestamp' ) ) ),
+        );
+
+    }
+
+    /**
+     * Retrieves last 90 days date range.
+     *
+     * @return array The appropriate date range.
+     */
+    public function get_90_days_date_range() {
+
+        $this->groupby = 'month';
+
+        // Set the previous date range.
+        $this->previous_range = array(
+            'period' => 'custom',
+            'before' => date( 'Y-m-d', strtotime( '-90 days', current_time( 'timestamp' ) ) ),
+            'after'  => date( 'Y-m-d', strtotime( '-181 days', current_time( 'timestamp' ) ) ),
+        );
+
+        // Generate the report.
+        return array(
+            'before' => date( 'Y-m-d', current_time( 'timestamp' ) ),
+            'after'  => date( 'Y-m-d', strtotime( '-91 days', current_time( 'timestamp' ) ) ),
+        );
+
+    }
+
+    /**
+     * Retrieves last 180 days date range.
+     *
+     * @return array The appropriate date range.
+     */
+    public function get_180_days_date_range() {
+
+        $this->groupby = 'month';
+
+        // Set the previous date range.
+        $this->previous_range = array(
+            'period' => 'custom',
+            'before' => date( 'Y-m-d', strtotime( '-180 days', current_time( 'timestamp' ) ) ),
+            'after'  => date( 'Y-m-d', strtotime( '-361 days', current_time( 'timestamp' ) ) ),
+        );
+
+        // Generate the report.
+        return array(
+            'before' => date( 'Y-m-d', current_time( 'timestamp' ) ),
+            'after'  => date( 'Y-m-d', strtotime( '-181 days', current_time( 'timestamp' ) ) ),
+        );
+
+    }
+
+    /**
+     * Retrieves last 60 days date range.
+     *
+     * @return array The appropriate date range.
+     */
+    public function get_60_days_date_range() {
+
+        // Set the previous date range.
+        $this->previous_range = array(
+            'period' => 'custom',
+            'before' => date( 'Y-m-d', strtotime( '-60 days', current_time( 'timestamp' ) ) ),
+            'after'  => date( 'Y-m-d', strtotime( '-121 days', current_time( 'timestamp' ) ) ),
+        );
+
+        // Generate the report.
+        return array(
+            'before' => date( 'Y-m-d', current_time( 'timestamp' ) ),
+            'after'  => date( 'Y-m-d', strtotime( '-61 days', current_time( 'timestamp' ) ) ),
+        );
+
+    }
+
+    /**
+     * Retrieves this month date range.
+     *
+     * @return array The appropriate date range.
+     */
+    public function get_month_date_range() {
+
+        // Set the previous date range.
+        $this->previous_range = array(
+            'period' => 'last_month',
+        );
+
+        // Generate the report.
+        return array(
+            'before' => date( 'Y-m-01', strtotime( 'next month', current_time( 'timestamp' ) ) ),
+            'after'  => date( 'Y-m-t', strtotime( 'last month', current_time( 'timestamp' ) ) ),
+        );
+
+    }
+
+    /**
+     * Retrieves last month's date range.
+     *
+     * @return array The appropriate date range.
+     */
+    public function get_last_month_date_range() {
+
+        // Set the previous date range.
+        $this->previous_range = array(
+            'period' => 'custom',
+            'before' => date( 'Y-m-1', strtotime( 'last month', current_time( 'timestamp' ) ) ),
+            'after'  => date( 'Y-m-t', strtotime( '-3 months', current_time( 'timestamp' ) ) ),
+        );
+
+        // Generate the report.
+        return array(
+            'before' => date( 'Y-m-1', current_time( 'timestamp' ) ),
+            'after'  => date( 'Y-m-t', strtotime( '-2 months', current_time( 'timestamp' ) ) ),
+        );
+
+    }
+
+    /**
+     * Retrieves this quarter date range.
+     *
+     * @return array The available quarters.
+     */
+    public function get_quarters() {
+
+        $last_year = (int) date( 'Y' ) - 1;
+        $next_year = (int) date( 'Y' ) + 1;
+        $year      = (int) date( 'Y' );
+        return array(
+
+            array(
+                'after'  => "$last_year-06-30",
+                'before' => "$last_year-10-01",
+            ),
+
+            array(
+                'before' => "$year-01-01",
+                'after'  => "$last_year-09-30",
+            ),
+
+            array(
+                'before' => "$year-04-01",
+                'after'  => "$last_year-12-31",
+            ),
+
+            array(
+                'before' => "$year-07-01",
+                'after'  => "$year-03-31",
+            ),
+
+            array(
+                'after'  => "$year-06-30",
+                'before' => "$year-10-01",
+            ),
+
+            array(
+                'before' => "$next_year-01-01",
+                'after'  => "$year-09-30",
+            ),
+
+        );
+
+    }
+
+    /**
+     * Retrieves the current quater.
+     *
+     * @return int The current quarter.
+     */
+    public function get_quarter() {
+
+        $month    = (int) date( 'n', current_time( 'timestamp' ) );
+        $quarters = array( 1, 1, 1, 2, 2, 2, 3, 3, 3, 4, 4, 4 );
+        return $quarters[ $month - 1 ];
+
+    }
+
+    /**
+     * Retrieves this quarter date range.
+     *
+     * @return array The appropriate date range.
+     */
+    public function get_quarter_date_range() {
+
+        // Set the previous date range.
+        $this->previous_range = array(
+            'period' => 'last_quarter',
+        );
+
+        // Generate the report.
+        $quarters = $this->get_quarters();
+        return $quarters[ $this->get_quarter() + 1 ];
+
+    }
+
+    /**
+     * Retrieves last quarter's date range.
+     *
+     * @return array The appropriate date range.
+     */
+    public function get_last_quarter_date_range() {
+
+        $quarters = $this->get_quarters();
+        $quarter  = $this->get_quarter();
+
+        // Set the previous date range.
+        $this->previous_range = array_merge(
+            $quarters[ $quarter - 1 ],
+            array( 'period' => 'custom' )
+        );
+
+        // Generate the report.
+        return $quarters[ $quarter ];
+
+    }
+
+    /**
+     * Retrieves this year date range.
+     *
+     * @return array The appropriate date range.
+     */
+    public function get_year_date_range() {
+
+        $this->groupby = 'month';
+
+        // Set the previous date range.
+        $this->previous_range = array(
+            'period' => 'last_year',
+        );
+
+        // Generate the report.
+        return array(
+            'before' => date( 'Y-m-d', strtotime( 'next year January 1st', current_time( 'timestamp' ) ) ),
+            'after'  => date( 'Y-m-d', strtotime( 'last year December 31st', current_time( 'timestamp' ) ) ),
+        );
+
+    }
+
+    /**
+     * Retrieves last year date range.
+     *
+     * @return array The appropriate date range.
+     */
+    public function get_last_year_date_range() {
+
+        $this->groupby = 'month';
+
+        // Set the previous date range.
+        $year          = (int) date( 'Y' ) - 3;
+        $this->previous_range = array(
+            'period' => 'custom',
+            'before' => date( 'Y-m-d', strtotime( 'first day of january last year', current_time( 'timestamp' ) ) ),
+            'after'  => "$year-12-31",
+        );
+
+        // Generate the report.
+        $year          = (int) date( 'Y' ) - 2;
+        return array(
+            'after'  => "$year-12-31",
+            'before' => date( 'Y-m-d', strtotime( 'first day of january this year', current_time( 'timestamp' ) ) ),
+        );
+
+    }
+
+    /**
+     * Prepare a the request date for SQL usage.
+     *
+     * @param WP_REST_Request $request Request object.
+     * @param string $date_field The date field.
+     * @return string The appropriate SQL.
+     */
+    public function get_date_range_sql( $request, $date_field ) {
+        global $wpdb;
+
+        $sql = '1=1';
+        $range = $this->get_date_range( $request );
+
+        if ( ! empty( $range['after'] ) ) {
+            $sql .= ' AND ' . $wpdb->prepare(
+                "$date_field > %s",
+                $range['after']
+            );
+        }
+
+        if ( ! empty( $range['before'] ) ) {
+            $sql .= ' AND ' . $wpdb->prepare(
+                "$date_field < %s",
+                $range['before']
+            );
+        }
+
+        return $sql;
+
+    }
+
+    /**
+     * Prepares a group by query.
+     *
+     * @param string $date_field The date field.
+     * @return string The appropriate SQL.
+     */
+    public function get_group_by_sql( $date_field ) {
+
+        if ( 'day' === $this->groupby ) {
+            return "YEAR($date_field), MONTH($date_field), DAY($date_field)";
+        }
+
+        return "YEAR($date_field), MONTH($date_field)";
+    }
+
+    /**
+     * Get the query params for collections.
+     *
+     * @return array
+     */
+    public function get_collection_params() {
+        return array(
+            'context' => $this->get_context_param( array( 'default' => 'view' ) ),
+            'period'  => array(
+                'description'       => __( 'Limit to results of a specific period.', 'invoicing' ),
+                'type'              => 'string',
+                'enum'              => array( 'custom', 'today', 'yesterday', 'week', 'last_week', '7_days', '30_days', '60_days', '90_days', '180_days', 'month', 'last_month', 'quarter', 'last_quarter', 'year', 'last_year', 'quarter', 'last_quarter' ),
+                'validate_callback' => 'rest_validate_request_arg',
+                'sanitize_callback' => 'sanitize_text_field',
+                'default'           => '7_days',
+            ),
+            'after'   => array(
+                /* translators: %s: date format */
+                'description'       => sprintf( __( 'Limit to results after a specific date, the date needs to be in the %s format.', 'invoicing' ), 'YYYY-MM-DD' ),
+                'type'              => 'string',
+                'format'            => 'date',
+                'validate_callback' => 'rest_validate_request_arg',
+                'sanitize_callback' => 'sanitize_text_field',
+                'default'           => date( 'Y-m-d', strtotime( '-8 days', current_time( 'timestamp' ) ) ),
+            ),
+            'before'  => array(
+                /* translators: %s: date format */
+                'description'       => sprintf( __( 'Limit to results before a specific date, the date needs to be in the %s format.', 'invoicing' ), 'YYYY-MM-DD' ),
+                'type'              => 'string',
+                'format'            => 'date',
+                'validate_callback' => 'rest_validate_request_arg',
+                'sanitize_callback' => 'sanitize_text_field',
+                'default'           => date( 'Y-m-d', current_time( 'timestamp' ) ),
+            ),
+        );
+    }
 }

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

Indentation +125 added lines, -125 removed lines

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