AyeCode / invoicing

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

Indentation +471 added lines, -471 removed lines

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

includes/class-getpaid-subscriptions-query.php

Indentation +490 added lines, -490 removed lines

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

includes/class-getpaid-notification-email.php

Indentation +56 added lines, -56 removed lines

@@ -13,36 +13,36 @@ 
 class GetPaid_Notification_Email {
 
     /**
-	 * Contains the type of this notification email.
-	 *
-	 * @var string
-	 */
+     * Contains the type of this notification email.
+     *
+     * @var string
+     */
     public $id;
 
     /**
-	 * Contains any object to use in filters.
-	 *
-	 * @var false|WPInv_Invoice|WPInv_Item|WPInv_Subscription
-	 */
+     * Contains any object to use in filters.
+     *
+     * @var false|WPInv_Invoice|WPInv_Item|WPInv_Subscription
+     */
     public $object;
 
     /**
-	 * Class constructor.
-	 *
+     * Class constructor.
+     *
      * @param string $id Email Type.
      * @param mixed $object Optional. Associated object.
-	 */
-	public function __construct( $id, $object = false ) {
+     */
+    public function __construct( $id, $object = false ) {
         $this->id     = $id;
         $this->object = $object;
     }
 
     /**
-	 * Retrieves an option
-	 *
+     * Retrieves an option
+     *
      * @return mixed
-	 */
-	public function get_option( $key ) {
+     */
+    public function get_option( $key ) {
 
         $key   = "email_{$this->id}_$key";
         $value = wpinv_get_option( $key, null );
@@ -60,80 +60,80 @@ 
     }
 
     /**
-	 * Retrieves the email body.
-	 *
+     * Retrieves the email body.
+     *
      * @return string
-	 */
-	public function get_body() {
+     */
+    public function get_body() {
         $body = $this->get_option( 'body' );
         return apply_filters( 'getpaid_get_email_body', $body, $this->id, $this->object );
     }
 
     /**
-	 * Retrieves the email subject.
-	 *
+     * Retrieves the email subject.
+     *
      * @return string
-	 */
-	public function get_subject() {
+     */
+    public function get_subject() {
         $subject = $this->get_option( 'subject' );
         return apply_filters( 'getpaid_get_email_subject', $subject, $this->id, $this->object );
     }
 
     /**
-	 * Retrieves the email heading.
-	 *
+     * Retrieves the email heading.
+     *
      * @return string
-	 */
-	public function get_heading() {
+     */
+    public function get_heading() {
         $heading = $this->get_option( 'heading' );
         return apply_filters( 'getpaid_get_email_heading', $heading, $this->id, $this->object );
     }
 
     /**
-	 * Checks if an email is active.
-	 *
+     * Checks if an email is active.
+     *
      * @return bool
-	 */
-	public function is_active() {
+     */
+    public function is_active() {
         $is_active = ! empty( $this->get_option( 'active' ) );
         return apply_filters( 'getpaid_email_type_is_active', $is_active, $this->id, $this->object );
     }
 
     /**
-	 * Checks if the site's admin should receive email notifications.
-	 *
+     * Checks if the site's admin should receive email notifications.
+     *
      * @return bool
-	 */
-	public function include_admin_bcc() {
+     */
+    public function include_admin_bcc() {
         $include_admin_bcc = ! empty( $this->get_option( 'admin_bcc' ) );
         return apply_filters( 'getpaid_email_type_include_admin_bcc', $include_admin_bcc, $this->id, $this->object );
     }
 
     /**
-	 * Checks whether this email should be sent to the customer or admin.
-	 *
+     * Checks whether this email should be sent to the customer or admin.
+     *
      * @return bool
-	 */
-	public function is_admin_email() {
+     */
+    public function is_admin_email() {
         $is_admin_email = in_array( $this->id, array( 'new_invoice', 'cancelled_invoice', 'failed_invoice' ) );
         return apply_filters( 'getpaid_email_type_is_admin_email', $is_admin_email, $this->id, $this->object );
     }
 
     /**
-	 * Returns email attachments.
-	 *
+     * Returns email attachments.
+     *
      * @return array
-	 */
-	public function get_attachments() {
+     */
+    public function get_attachments() {
         return apply_filters( 'getpaid_get_email_attachments', array(), $this->id, $this->object );
     }
 
     /**
-	 * Returns an array of merge tags.
-	 *
+     * Returns an array of merge tags.
+     *
      * @return array
-	 */
-	public function get_merge_tags() {
+     */
+    public function get_merge_tags() {
 
         $merge_tags = array(
             '{site_title}' => wpinv_get_blogname(),
@@ -144,13 +144,13 @@ 
     }
 
     /**
-	 * Adds merge tags to a text.
-	 *
+     * Adds merge tags to a text.
+     *
      * @param string string $text
      * @param array $merge_tags
      * @return string
-	 */
-	public function add_merge_tags( $text, $merge_tags = array() ) {
+     */
+    public function add_merge_tags( $text, $merge_tags = array() ) {
 
         foreach ( $merge_tags as $key => $value ) {
             $text = str_replace( $key, $value, $text );
@@ -160,13 +160,13 @@ 
     }
 
     /**
-	 * Returns the email content
-	 *
+     * Returns the email content
+     *
      * @param array $merge_tags
      * @param array $extra_args Extra template args
      * @return string
-	 */
-	public function get_content( $merge_tags = array(), $extra_args = array() ) {
+     */
+    public function get_content( $merge_tags = array(), $extra_args = array() ) {
 
         $content = wpinv_get_template_html(
             "emails/wpinv-email-{$this->id}.php",

includes/gateways/class-getpaid-authorize-net-legacy-gateway.php

Indentation +50 added lines, -50 removed lines

@@ -15,31 +15,31 @@ 
 abstract class GetPaid_Authorize_Net_Legacy_Gateway extends GetPaid_Payment_Gateway {
 
     /**
-	 * Class constructor.
-	 */
-	public function __construct() {
+     * Class constructor.
+     */
+    public function __construct() {
         parent::__construct();
     }
 
     /**
-	 * Returns the API URL.
-	 *
-	 *
-	 * @param WPInv_Invoice $invoice Invoice.
-	 * @return string
-	 */
-	public function get_api_url( $invoice ) {
+     * Returns the API URL.
+     *
+     *
+     * @param WPInv_Invoice $invoice Invoice.
+     * @return string
+     */
+    public function get_api_url( $invoice ) {
         return $this->is_sandbox( $invoice ) ? 'https://apitest.authorize.net/xml/v1/request.api' : 'https://api.authorize.net/xml/v1/request.api';
     }
 
     /**
-	 * Communicates with authorize.net
-	 *
-	 *
-	 * @param array $post Data to post.
+     * Communicates with authorize.net
+     *
+     *
+     * @param array $post Data to post.
      * @param WPInv_Invoice $invoice Invoice.
-	 * @return stdClass|WP_Error
-	 */
+     * @return stdClass|WP_Error
+     */
     public function post( $post, $invoice ){
 
         $url      = $this->get_api_url( $invoice );
@@ -81,12 +81,12 @@ 
     }
 
     /**
-	 * Returns the API authentication params.
-	 *
-	 *
-	 * @return array
-	 */
-	public function get_auth_params() {
+     * Returns the API authentication params.
+     *
+     *
+     * @return array
+     */
+    public function get_auth_params() {
 
         return array(
             'name'           => $this->get_option( 'login_id' ),
@@ -96,13 +96,13 @@ 
     }
 
     /**
-	 * Cancels a subscription remotely
-	 *
-	 *
-	 * @param WPInv_Subscription $subscription Subscription.
+     * Cancels a subscription remotely
+     *
+     *
+     * @param WPInv_Subscription $subscription Subscription.
      * @param WPInv_Invoice $invoice Invoice.
-	 */
-	public function cancel_subscription( $subscription, $invoice ) {
+     */
+    public function cancel_subscription( $subscription, $invoice ) {
 
         // Backwards compatibility. New version do not use authorize.net subscriptions.
         $this->post(
@@ -118,17 +118,17 @@ 
     }
 
     /**
-	 * Processes ipns.
-	 *
-	 * @return void
-	 */
-	public function verify_ipn() {
+     * Processes ipns.
+     *
+     * @return void
+     */
+    public function verify_ipn() {
 
         $this->maybe_process_old_ipn();
 
         // Validate the IPN.
         if ( empty( $_POST ) || ! $this->validate_ipn() ) {
-		    wp_die( 'Authorize.NET IPN Request Failure', 'Authorize.NET IPN', array( 'response' => 500 ) );
+            wp_die( 'Authorize.NET IPN Request Failure', 'Authorize.NET IPN', array( 'response' => 500 ) );
         }
 
         // Event type.
@@ -167,24 +167,24 @@ 
     }
 
     /**
-	 * Validates IPN invoices.
-	 *
+     * Validates IPN invoices.
+     *
      * @param WPInv_Invoice $invoice
      * @param object $payload
-	 * @return void
-	 */
-	public function validate_ipn_invoice( $invoice, $payload ) {
+     * @return void
+     */
+    public function validate_ipn_invoice( $invoice, $payload ) {
         if ( ! $invoice->exists() || $payload->id != $invoice->get_transaction_id() ) {
             exit;
         }
     }
 
     /**
-	 * Process subscriptio IPNS.
-	 *
-	 * @return void
-	 */
-	public function maybe_process_old_ipn() {
+     * Process subscriptio IPNS.
+     *
+     * @return void
+     */
+    public function maybe_process_old_ipn() {
 
         $data = wp_unslash( $_POST );
 
@@ -226,11 +226,11 @@ 
     }
 
     /**
-	 * Validates the old IPN signature.
+     * Validates the old IPN signature.
      *
      * @param array $posted
-	 */
-	public function validate_old_ipn_signature( $posted ) {
+     */
+    public function validate_old_ipn_signature( $posted ) {
 
         $signature = $this->get_option( 'signature_key' );
         if ( ! empty( $signature ) ) {
@@ -249,9 +249,9 @@ 
     }
 
     /**
-	 * Check Authorize.NET IPN validity.
-	 */
-	public function validate_ipn() {
+     * Check Authorize.NET IPN validity.
+     */
+    public function validate_ipn() {
 
         wpinv_error_log( 'Validating Authorize.NET IPN response' );
 

includes/wpinv-email-functions.php

Indentation +3 added lines, -3 removed lines

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

includes/error-functions.php

Indentation +8 added lines, -8 removed lines

@@ -117,14 +117,14 @@
  */
 function getpaid_doing_it_wrong( $function, $message, $version ) {
 
-	$message .= ' Backtrace: ' . wp_debug_backtrace_summary();
-
-	if ( wp_doing_ajax() || defined( 'REST_REQUEST' ) ) {
-		do_action( 'doing_it_wrong_run', $function, $message, $version );
-		error_log( "{$function} was called incorrectly. {$message}. This message was added in version {$version}." );
-	} else {
-		_doing_it_wrong( $function, $message, $version );
-	}
+    $message .= ' Backtrace: ' . wp_debug_backtrace_summary();
+
+    if ( wp_doing_ajax() || defined( 'REST_REQUEST' ) ) {
+        do_action( 'doing_it_wrong_run', $function, $message, $version );
+        error_log( "{$function} was called incorrectly. {$message}. This message was added in version {$version}." );
+    } else {
+        _doing_it_wrong( $function, $message, $version );
+    }
 
 }
 

includes/payments/class-getpaid-payment-forms.php

Indentation +123 added lines, -123 removed lines

@@ -13,128 +13,128 @@
 class GetPaid_Payment_Forms {
 
     /**
-	 * Class constructor
-	 *
-	 */
-	public function __construct() {
-
-		// Update a payment form's revenue whenever an invoice is paid for or refunded.
-		add_action( 'getpaid_invoice_payment_status_changed', array( $this, 'increment_form_revenue' ) );
-		add_action( 'getpaid_invoice_payment_status_reversed', array( $this, 'decrease_form_revenue' ) );
-
-		// Sync form amount whenever invoice statuses change.
-		add_action( 'getpaid_invoice_status_changed', array( $this, 'update_form_failed_amount' ), 10, 3 );
-		add_action( 'getpaid_invoice_status_changed', array( $this, 'update_form_refunded_amount' ), 10, 3 );
-		add_action( 'getpaid_invoice_status_changed', array( $this, 'update_form_cancelled_amount' ), 10, 3 );
-
-	}
-
-	/**
-	 * Increments a form's revenue whenever there is a payment.
-	 *
-	 * @param WPInv_Invoice $invoice
-	 */
-	public function increment_form_revenue( $invoice ) {
-
-		$form = new GetPaid_Payment_Form( $invoice->get_payment_form() );
-		if ( $form->get_id() ) {
-			$form->set_earned( $form->get_earned() + $invoice->get_total() );
-			$form->save();
-		}
-
-	}
-
-	/**
-	 * Decreases form revenue whenever invoice payment changes.
-	 *
-	 * @param WPInv_Invoice $invoice
-	 */
-	public function decrease_form_revenue( $invoice ) {
-
-		$form = new GetPaid_Payment_Form( $invoice->get_payment_form() );
-		if ( $form->get_id() ) {
-			$form->set_earned( $form->get_earned() - $invoice->get_total() );
-			$form->save();
-		}
-
-	}
-
-	/**
-	 * Updates a form's failed amount.
-	 *
-	 * @param WPInv_Invoice $invoice
-	 * @param string $from
-	 * @param string $to
-	 */
-	public function update_form_failed_amount( $invoice, $from, $to ) {
-
-		$form = new GetPaid_Payment_Form( $invoice->get_payment_form() );
-		if ( $form->get_id() ) {
-			return;
-		}
-
-		if ( 'wpi-failed' == $from ) {
-			$form->set_failed( $form->get_failed() - $invoice->get_total() );
-			$form->save();
-		}
-
-		if ( 'wpi-failed' == $to ) {
-			$form->set_failed( $form->get_failed() + $invoice->get_total() );
-			$form->save();
-		}
-
-	}
-
-	/**
-	 * Updates a form's refunded amount.
-	 *
-	 * @param WPInv_Invoice $invoice
-	 * @param string $from
-	 * @param string $to
-	 */
-	public function update_form_refunded_amount( $invoice, $from, $to ) {
-
-		$form = new GetPaid_Payment_Form( $invoice->get_payment_form() );
-		if ( $form->get_id() ) {
-			return;
-		}
-
-		if ( 'wpi-refunded' == $from ) {
-			$form->set_refunded( $form->get_refunded() - $invoice->get_total() );
-			$form->save();
-		}
-
-		if ( 'wpi-refunded' == $to ) {
-			$form->set_refunded( $form->get_refunded() + $invoice->get_total() );
-			$form->save();
-		}
-
-	}
-
-	/**
-	 * Updates a form's cancelled amount.
-	 *
-	 * @param WPInv_Invoice $invoice
-	 * @param string $from
-	 * @param string $to
-	 */
-	public function update_form_cancelled_amount( $invoice, $from, $to ) {
-
-		$form = new GetPaid_Payment_Form( $invoice->get_payment_form() );
-		if ( $form->get_id() ) {
-			return;
-		}
-
-		if ( 'wpi-cancelled' == $from ) {
-			$form->set_cancelled( $form->get_cancelled() - $invoice->get_total() );
-			$form->save();
-		}
-
-		if ( 'wpi-cancelled' == $to ) {
-			$form->set_cancelled( $form->get_cancelled() + $invoice->get_total() );
-			$form->save();
-		}
-
-	}
+     * Class constructor
+     *
+     */
+    public function __construct() {
+
+        // Update a payment form's revenue whenever an invoice is paid for or refunded.
+        add_action( 'getpaid_invoice_payment_status_changed', array( $this, 'increment_form_revenue' ) );
+        add_action( 'getpaid_invoice_payment_status_reversed', array( $this, 'decrease_form_revenue' ) );
+
+        // Sync form amount whenever invoice statuses change.
+        add_action( 'getpaid_invoice_status_changed', array( $this, 'update_form_failed_amount' ), 10, 3 );
+        add_action( 'getpaid_invoice_status_changed', array( $this, 'update_form_refunded_amount' ), 10, 3 );
+        add_action( 'getpaid_invoice_status_changed', array( $this, 'update_form_cancelled_amount' ), 10, 3 );
+
+    }
+
+    /**
+     * Increments a form's revenue whenever there is a payment.
+     *
+     * @param WPInv_Invoice $invoice
+     */
+    public function increment_form_revenue( $invoice ) {
+
+        $form = new GetPaid_Payment_Form( $invoice->get_payment_form() );
+        if ( $form->get_id() ) {
+            $form->set_earned( $form->get_earned() + $invoice->get_total() );
+            $form->save();
+        }
+
+    }
+
+    /**
+     * Decreases form revenue whenever invoice payment changes.
+     *
+     * @param WPInv_Invoice $invoice
+     */
+    public function decrease_form_revenue( $invoice ) {
+
+        $form = new GetPaid_Payment_Form( $invoice->get_payment_form() );
+        if ( $form->get_id() ) {
+            $form->set_earned( $form->get_earned() - $invoice->get_total() );
+            $form->save();
+        }
+
+    }
+
+    /**
+     * Updates a form's failed amount.
+     *
+     * @param WPInv_Invoice $invoice
+     * @param string $from
+     * @param string $to
+     */
+    public function update_form_failed_amount( $invoice, $from, $to ) {
+
+        $form = new GetPaid_Payment_Form( $invoice->get_payment_form() );
+        if ( $form->get_id() ) {
+            return;
+        }
+
+        if ( 'wpi-failed' == $from ) {
+            $form->set_failed( $form->get_failed() - $invoice->get_total() );
+            $form->save();
+        }
+
+        if ( 'wpi-failed' == $to ) {
+            $form->set_failed( $form->get_failed() + $invoice->get_total() );
+            $form->save();
+        }
+
+    }
+
+    /**
+     * Updates a form's refunded amount.
+     *
+     * @param WPInv_Invoice $invoice
+     * @param string $from
+     * @param string $to
+     */
+    public function update_form_refunded_amount( $invoice, $from, $to ) {
+
+        $form = new GetPaid_Payment_Form( $invoice->get_payment_form() );
+        if ( $form->get_id() ) {
+            return;
+        }
+
+        if ( 'wpi-refunded' == $from ) {
+            $form->set_refunded( $form->get_refunded() - $invoice->get_total() );
+            $form->save();
+        }
+
+        if ( 'wpi-refunded' == $to ) {
+            $form->set_refunded( $form->get_refunded() + $invoice->get_total() );
+            $form->save();
+        }
+
+    }
+
+    /**
+     * Updates a form's cancelled amount.
+     *
+     * @param WPInv_Invoice $invoice
+     * @param string $from
+     * @param string $to
+     */
+    public function update_form_cancelled_amount( $invoice, $from, $to ) {
+
+        $form = new GetPaid_Payment_Form( $invoice->get_payment_form() );
+        if ( $form->get_id() ) {
+            return;
+        }
+
+        if ( 'wpi-cancelled' == $from ) {
+            $form->set_cancelled( $form->get_cancelled() - $invoice->get_total() );
+            $form->save();
+        }
+
+        if ( 'wpi-cancelled' == $to ) {
+            $form->set_cancelled( $form->get_cancelled() + $invoice->get_total() );
+            $form->save();
+        }
+
+    }
 
 }

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

Indentation +26 added lines, -26 removed lines

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

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

Indentation +73 added lines, -73 removed lines

@@ -1,7 +1,7 @@ 
 <?php
 
 if ( ! defined( 'ABSPATH' ) ) {
-	exit; // Exit if accessed directly
+    exit; // Exit if accessed directly
 }
 
 /**
@@ -11,77 +11,77 @@ 
  */
 class AUI_Component_Pagination {
 
-	/**
-	 * Build the component.
-	 *
-	 * @param array $args
-	 *
-	 * @return string The rendered component.
-	 */
-	public static function get( $args = array() ) {
-		global $wp_query;
-
-		$defaults = array(
-			'class'              => '',
-			'mid_size'           => 2,
-			'prev_text'          => '<i class="fas fa-chevron-left"></i>',
-			'next_text'          => '<i class="fas fa-chevron-right"></i>',
-			'screen_reader_text' => __( 'Posts navigation','aui' ),
-			'before_paging' => '',
-			'after_paging'  => '',
-			'type'               => 'array',
-			'total'              => isset( $wp_query->max_num_pages ) ? $wp_query->max_num_pages : 1,
-			'links'              => array() // an array of links if using custom links, this includes the a tag.
-		);
-
-		/**
-		 * Parse incoming $args into an array and merge it with $defaults
-		 */
-		$args = wp_parse_args( $args, $defaults );
-
-		$output = '';
-
-		// Don't print empty markup if there's only one page.
-		if ( $args['total'] > 1 ) {
-
-			// Set up paginated links.
-			$links = !empty(  $args['links'] ) ? $args['links'] :  paginate_links( $args );
-
-			$class = !empty($args['class']) ? $args['class'] : '';
-
-			// make the output bootstrap ready
-			$links_html = "<ul class='pagination m-0 p-0 $class'>";
-			if ( ! empty( $links ) ) {
-				foreach ( $links as $link ) {
-					$active = strpos( $link, 'current' ) !== false ? 'active' : '';
-					$links_html .= "<li class='page-item $active'>";
-					$links_html .= str_replace( "page-numbers", "page-link", $link );
-					$links_html .= "</li>";
-				}
-			}
-			$links_html .= "</ul>";
-
-			if ( $links ) {
-				$output .= '<section class="px-0 py-2 w-100">';
-				$output .= _navigation_markup( $links_html, 'aui-pagination', $args['screen_reader_text'] );
-				$output .= '</section>';
-			}
-
-			$output = str_replace( "screen-reader-text", "screen-reader-text sr-only", $output );
-			$output = str_replace( "nav-links", "aui-nav-links", $output );
-		}
-
-		if ( $output ) {
-			if ( ! empty( $args['before_paging'] ) ) {
-				$output = $args['before_paging'] . $output;
-			}
-
-			if ( ! empty( $args['after_paging'] ) ) {
-				$output = $output . $args['after_paging'];
-			}
-		}
-
-		return $output;
-	}
+    /**
+     * Build the component.
+     *
+     * @param array $args
+     *
+     * @return string The rendered component.
+     */
+    public static function get( $args = array() ) {
+        global $wp_query;
+
+        $defaults = array(
+            'class'              => '',
+            'mid_size'           => 2,
+            'prev_text'          => '<i class="fas fa-chevron-left"></i>',
+            'next_text'          => '<i class="fas fa-chevron-right"></i>',
+            'screen_reader_text' => __( 'Posts navigation','aui' ),
+            'before_paging' => '',
+            'after_paging'  => '',
+            'type'               => 'array',
+            'total'              => isset( $wp_query->max_num_pages ) ? $wp_query->max_num_pages : 1,
+            'links'              => array() // an array of links if using custom links, this includes the a tag.
+        );
+
+        /**
+         * Parse incoming $args into an array and merge it with $defaults
+         */
+        $args = wp_parse_args( $args, $defaults );
+
+        $output = '';
+
+        // Don't print empty markup if there's only one page.
+        if ( $args['total'] > 1 ) {
+
+            // Set up paginated links.
+            $links = !empty(  $args['links'] ) ? $args['links'] :  paginate_links( $args );
+
+            $class = !empty($args['class']) ? $args['class'] : '';
+
+            // make the output bootstrap ready
+            $links_html = "<ul class='pagination m-0 p-0 $class'>";
+            if ( ! empty( $links ) ) {
+                foreach ( $links as $link ) {
+                    $active = strpos( $link, 'current' ) !== false ? 'active' : '';
+                    $links_html .= "<li class='page-item $active'>";
+                    $links_html .= str_replace( "page-numbers", "page-link", $link );
+                    $links_html .= "</li>";
+                }
+            }
+            $links_html .= "</ul>";
+
+            if ( $links ) {
+                $output .= '<section class="px-0 py-2 w-100">';
+                $output .= _navigation_markup( $links_html, 'aui-pagination', $args['screen_reader_text'] );
+                $output .= '</section>';
+            }
+
+            $output = str_replace( "screen-reader-text", "screen-reader-text sr-only", $output );
+            $output = str_replace( "nav-links", "aui-nav-links", $output );
+        }
+
+        if ( $output ) {
+            if ( ! empty( $args['before_paging'] ) ) {
+                $output = $args['before_paging'] . $output;
+            }
+
+            if ( ! empty( $args['after_paging'] ) ) {
+                $output = $output . $args['after_paging'];
+            }
+        }
+
+        return $output;
+    }
 
 }
\ No newline at end of file