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

widgets/subscriptions.php

Indentation +331 added lines, -331 removed lines

@@ -14,144 +14,144 @@ 
  */
 class WPInv_Subscriptions_Widget extends WP_Super_Duper {
 
-	/**
-	 * Register the widget with WordPress.
-	 *
-	 */
-	public function __construct() {
-
-		$options = array(
-			'textdomain'    => 'invoicing',
-			'block-icon'    => 'controls-repeat',
-			'block-category'=> 'widgets',
-			'block-keywords'=> "['invoicing','subscriptions', 'getpaid']",
-			'class_name'     => __CLASS__,
-			'base_id'       => 'wpinv_subscriptions',
-			'name'          => __( 'GetPaid > Subscriptions', 'invoicing' ),
-			'widget_ops'    => array(
-				'classname'   => 'getpaid-subscriptions bsui',
-				'description' => esc_html__( "Displays the current user's subscriptions.", 'invoicing' ),
-			),
-			'arguments'     => array(
-				'title'  => array(
-					'title'       => __( 'Widget title', 'invoicing' ),
-					'desc'        => __( 'Enter widget title.', 'invoicing' ),
-					'type'        => 'text',
-					'desc_tip'    => true,
-					'default'     => '',
-					'advanced'    => false
-				),
-			)
-
-		);
-
-
-		parent::__construct( $options );
-	}
-
-	/**
-	 * Retrieves current user's subscriptions.
-	 *
-	 * @return GetPaid_Subscriptions_Query
-	 */
-	public function get_subscriptions() {
-
-		// Prepare license args.
-		$args  = array(
-			'customer_in' => get_current_user_id(),
-			'paged'       => ( get_query_var( 'paged' ) ) ? absint( get_query_var( 'paged' ) ) : 1,
-		);
-
-		return new GetPaid_Subscriptions_Query( $args );
-
-	}
-
-	/**
-	 * The Super block output function.
-	 *
-	 * @param array $args
-	 * @param array $widget_args
-	 * @param string $content
-	 *
-	 * @return mixed|string|bool
-	 */
-	public function output( $args = array(), $widget_args = array(), $content = '' ) {
-
-		// Ensure that the user is logged in.
-		if ( ! is_user_logged_in() ) {
-
-			return aui()->alert(
-				array(
-					'content' => wp_kses_post( __( 'You need to log-in or create an account to view this section.', 'invoicing' ) ),
-					'type'    => 'error',
-				)
-			);
-
-		}
-
-		// Are we displaying a single subscription?
-		if ( isset( $_GET['subscription'] ) ) {
-			return $this->display_single_subscription( trim( $_GET['subscription'] ) );
-		}
-
-		// Retrieve the user's subscriptions.
-		$subscriptions = $this->get_subscriptions();
-
-		// Start the output buffer.
-		ob_start();
-
-		// Backwards compatibility.
-		do_action( 'wpinv_before_user_subscriptions' );
-
-		// Display errors and notices.
-		wpinv_print_errors();
-
-		do_action( 'getpaid_license_manager_before_subscriptions', $subscriptions );
-
-		// Print the table header.
-		$this->print_table_header();
-
-		// Print table body.
-		$this->print_table_body( $subscriptions->get_results() );
-
-		// Print table footer.
-		$this->print_table_footer();
-
-		// Print the navigation.
-		$this->print_navigation( $subscriptions->get_total() );
-
-		// Backwards compatibility.
-		do_action( 'wpinv_after_user_subscriptions' );
-
-		// Return the output.
-		return ob_get_clean();
-
-	}
-
-	/**
-	 * Retrieves the subscription columns.
-	 *
-	 * @return array
-	 */
-	public function get_subscriptions_table_columns() {
+    /**
+     * Register the widget with WordPress.
+     *
+     */
+    public function __construct() {
+
+        $options = array(
+            'textdomain'    => 'invoicing',
+            'block-icon'    => 'controls-repeat',
+            'block-category'=> 'widgets',
+            'block-keywords'=> "['invoicing','subscriptions', 'getpaid']",
+            'class_name'     => __CLASS__,
+            'base_id'       => 'wpinv_subscriptions',
+            'name'          => __( 'GetPaid > Subscriptions', 'invoicing' ),
+            'widget_ops'    => array(
+                'classname'   => 'getpaid-subscriptions bsui',
+                'description' => esc_html__( "Displays the current user's subscriptions.", 'invoicing' ),
+            ),
+            'arguments'     => array(
+                'title'  => array(
+                    'title'       => __( 'Widget title', 'invoicing' ),
+                    'desc'        => __( 'Enter widget title.', 'invoicing' ),
+                    'type'        => 'text',
+                    'desc_tip'    => true,
+                    'default'     => '',
+                    'advanced'    => false
+                ),
+            )
+
+        );
+
+
+        parent::__construct( $options );
+    }
+
+    /**
+     * Retrieves current user's subscriptions.
+     *
+     * @return GetPaid_Subscriptions_Query
+     */
+    public function get_subscriptions() {
+
+        // Prepare license args.
+        $args  = array(
+            'customer_in' => get_current_user_id(),
+            'paged'       => ( get_query_var( 'paged' ) ) ? absint( get_query_var( 'paged' ) ) : 1,
+        );
+
+        return new GetPaid_Subscriptions_Query( $args );
+
+    }
+
+    /**
+     * The Super block output function.
+     *
+     * @param array $args
+     * @param array $widget_args
+     * @param string $content
+     *
+     * @return mixed|string|bool
+     */
+    public function output( $args = array(), $widget_args = array(), $content = '' ) {
+
+        // Ensure that the user is logged in.
+        if ( ! is_user_logged_in() ) {
+
+            return aui()->alert(
+                array(
+                    'content' => wp_kses_post( __( 'You need to log-in or create an account to view this section.', 'invoicing' ) ),
+                    'type'    => 'error',
+                )
+            );
+
+        }
+
+        // Are we displaying a single subscription?
+        if ( isset( $_GET['subscription'] ) ) {
+            return $this->display_single_subscription( trim( $_GET['subscription'] ) );
+        }
+
+        // Retrieve the user's subscriptions.
+        $subscriptions = $this->get_subscriptions();
+
+        // Start the output buffer.
+        ob_start();
+
+        // Backwards compatibility.
+        do_action( 'wpinv_before_user_subscriptions' );
+
+        // Display errors and notices.
+        wpinv_print_errors();
+
+        do_action( 'getpaid_license_manager_before_subscriptions', $subscriptions );
+
+        // Print the table header.
+        $this->print_table_header();
+
+        // Print table body.
+        $this->print_table_body( $subscriptions->get_results() );
+
+        // Print table footer.
+        $this->print_table_footer();
+
+        // Print the navigation.
+        $this->print_navigation( $subscriptions->get_total() );
+
+        // Backwards compatibility.
+        do_action( 'wpinv_after_user_subscriptions' );
+
+        // Return the output.
+        return ob_get_clean();
+
+    }
+
+    /**
+     * Retrieves the subscription columns.
+     *
+     * @return array
+     */
+    public function get_subscriptions_table_columns() {
 
-		$columns = array(
-			'subscription'   => __( 'Subscription', 'invoicing' ),
-			'amount'         => __( 'Amount', 'invoicing' ),
-			'renewal-date'   => __( 'Next payment', 'invoicing' ),
-			'status'         => __( 'Status', 'invoicing' ),
-		);
+        $columns = array(
+            'subscription'   => __( 'Subscription', 'invoicing' ),
+            'amount'         => __( 'Amount', 'invoicing' ),
+            'renewal-date'   => __( 'Next payment', 'invoicing' ),
+            'status'         => __( 'Status', 'invoicing' ),
+        );
 
-		return apply_filters( 'getpaid_frontend_subscriptions_table_columns', $columns );
-	}
+        return apply_filters( 'getpaid_frontend_subscriptions_table_columns', $columns );
+    }
 
-	/**
-	 * Displays the table header.
-	 *
-	 */
-	public function print_table_header() {
+    /**
+     * Displays the table header.
+     *
+     */
+    public function print_table_header() {
 
-		?>
+        ?>
 
 			<table class="table table-bordered table-striped">
 
@@ -167,120 +167,120 @@ 
 
 		<?php
 
-	}
+    }
 
-	/**
-	 * Displays the table body.
-	 *
-	 * @param WPInv_Subscription[] $subscriptions
-	 */
-	public function print_table_body( $subscriptions ) {
+    /**
+     * Displays the table body.
+     *
+     * @param WPInv_Subscription[] $subscriptions
+     */
+    public function print_table_body( $subscriptions ) {
 
-		if ( empty( $subscriptions ) ) {
-			$this->print_table_body_no_subscriptions();
-		} else {
-			$this->print_table_body_subscriptions( $subscriptions );
-		}
+        if ( empty( $subscriptions ) ) {
+            $this->print_table_body_no_subscriptions();
+        } else {
+            $this->print_table_body_subscriptions( $subscriptions );
+        }
 
-	}
+    }
 
-	/**
-	 * Displays the table body if no subscriptions were found.
-	 *
-	 */
-	public function print_table_body_no_subscriptions() {
+    /**
+     * Displays the table body if no subscriptions were found.
+     *
+     */
+    public function print_table_body_no_subscriptions() {
 
-		?>
+        ?>
 		<tbody>
 
 			<tr>
 				<td colspan="<?php echo count( $this->get_subscriptions_table_columns() ); ?>">
 
 					<?php
-						echo aui()->alert(
-							array(
-								'content' => wp_kses_post( __( 'No subscriptions found.', 'invoicing' ) ),
-								'type'    => 'warning',
-							)
-						);
-					?>
+                        echo aui()->alert(
+                            array(
+                                'content' => wp_kses_post( __( 'No subscriptions found.', 'invoicing' ) ),
+                                'type'    => 'warning',
+                            )
+                        );
+                    ?>
 
 				</td>
 			</tr>
 
 		</tbody>
 		<?php
-	}
+    }
 
-	/**
-	 * Displays the table body if subscriptions were found.
-	 *
-	 * @param WPInv_Subscription[] $subscriptions
-	 */
-	public function print_table_body_subscriptions( $subscriptions ) {
+    /**
+     * Displays the table body if subscriptions were found.
+     *
+     * @param WPInv_Subscription[] $subscriptions
+     */
+    public function print_table_body_subscriptions( $subscriptions ) {
 
-		?>
+        ?>
 		<tbody>
 
 			<?php foreach ( $subscriptions as $subscription ) : ?>
 				<tr class="getpaid-subscriptions-table-row subscription-<?php echo (int) $subscription->get_id(); ?>">
 					<?php
-						wpinv_get_template(
-							'subscriptions/subscriptions-table-row.php',
-							array(
-								'subscription' => $subscription,
-								'widget'       => $this
-							)
-						);
-					?>
+                        wpinv_get_template(
+                            'subscriptions/subscriptions-table-row.php',
+                            array(
+                                'subscription' => $subscription,
+                                'widget'       => $this
+                            )
+                        );
+                    ?>
 				</tr>
 			<?php endforeach; ?>
 
 		</tbody>
 		<?php
-	}
-
-	/**
-	 * Adds row actions to a column
-	 *
-	 * @param string $content column content
-	 * @param WPInv_Subscription $subscription
-	 * @since       1.0.0
-	 * @return      string
-	 */
-	public function add_row_actions( $content, $subscription ) {
-
-		// Prepare row actions.
-		$actions = array();
-
-		// View subscription action.
-		$view_url        = esc_url( add_query_arg( 'subscription', (int) $subscription->get_id(), get_permalink( (int) wpinv_get_option( 'invoice_subscription_page' ) ) ) );
-		$actions['view'] = "<a href='$view_url' class='text-decoration-none'>" . __( 'Manage Subscription', 'invoicing' ) . '</a>';
-
-		// Filter the actions.
-		$actions = apply_filters( 'getpaid_subscriptions_table_subscription_actions', $actions, $subscription );
-
-		$sanitized  = array();
-		foreach ( $actions as $key => $action ) {
-			$key         = sanitize_html_class( $key );
-			$action      = wp_kses_post( $action );
-			$sanitized[] = "<span class='$key'>$action</span>";
-		}
-
-		$row_actions  = "<small class='form-text getpaid-subscription-item-actions'>";
-		$row_actions .= implode( ' | ', $sanitized );
-		$row_actions .= '</small>';
-
-		return $content . $row_actions;
-	}
-
-	/**
-	 * Displays the table footer.
-	 *
-	 */
-	public function print_table_footer() {
-
-		?>
+    }
+
+    /**
+     * Adds row actions to a column
+     *
+     * @param string $content column content
+     * @param WPInv_Subscription $subscription
+     * @since       1.0.0
+     * @return      string
+     */
+    public function add_row_actions( $content, $subscription ) {
+
+        // Prepare row actions.
+        $actions = array();
+
+        // View subscription action.
+        $view_url        = esc_url( add_query_arg( 'subscription', (int) $subscription->get_id(), get_permalink( (int) wpinv_get_option( 'invoice_subscription_page' ) ) ) );
+        $actions['view'] = "<a href='$view_url' class='text-decoration-none'>" . __( 'Manage Subscription', 'invoicing' ) . '</a>';
+
+        // Filter the actions.
+        $actions = apply_filters( 'getpaid_subscriptions_table_subscription_actions', $actions, $subscription );
+
+        $sanitized  = array();
+        foreach ( $actions as $key => $action ) {
+            $key         = sanitize_html_class( $key );
+            $action      = wp_kses_post( $action );
+            $sanitized[] = "<span class='$key'>$action</span>";
+        }
+
+        $row_actions  = "<small class='form-text getpaid-subscription-item-actions'>";
+        $row_actions .= implode( ' | ', $sanitized );
+        $row_actions .= '</small>';
+
+        return $content . $row_actions;
+    }
+
+    /**
+     * Displays the table footer.
+     *
+     */
+    public function print_table_footer() {
+
+        ?>
 
 				<tfoot>
 					<tr>
@@ -295,129 +295,129 @@ 
 			</table>
 		<?php
 
-	}
+    }
 
-	/**
-	 * Displays the navigation.
-	 *
-	 * @param int $total
-	 */
-	public function print_navigation( $total ) {
+    /**
+     * Displays the navigation.
+     *
+     * @param int $total
+     */
+    public function print_navigation( $total ) {
 
-		if ( $total < 1 ) {
+        if ( $total < 1 ) {
 
-			// Out-of-bounds, run the query again without LIMIT for total count.
-			$args  = array(
-				'customer_in' => get_current_user_id(),
-				'fields'      => 'id',
-			);
+            // Out-of-bounds, run the query again without LIMIT for total count.
+            $args  = array(
+                'customer_in' => get_current_user_id(),
+                'fields'      => 'id',
+            );
 
-			$count_query = new GetPaid_Subscriptions_Query( $args );
-			$total       = $count_query->get_total();
-		}
+            $count_query = new GetPaid_Subscriptions_Query( $args );
+            $total       = $count_query->get_total();
+        }
 
-		// Abort if we do not have pages.
-		if ( 2 > $total ) {
-			return;
-		}
+        // Abort if we do not have pages.
+        if ( 2 > $total ) {
+            return;
+        }
 
-		?>
+        ?>
 
 		<div class="getpaid-subscriptions-pagination">
 			<?php
-				$big = 999999;
-
-				echo getpaid_paginate_links(
-					array(
-						'base'    => str_replace( $big, '%#%', esc_url( get_pagenum_link( $big ) ) ),
-						'format'  => '?paged=%#%',
-						'total'   => (int) ceil( $total / 10 ),
-					)
-				);
-			?>
+                $big = 999999;
+
+                echo getpaid_paginate_links(
+                    array(
+                        'base'    => str_replace( $big, '%#%', esc_url( get_pagenum_link( $big ) ) ),
+                        'format'  => '?paged=%#%',
+                        'total'   => (int) ceil( $total / 10 ),
+                    )
+                );
+            ?>
 		</div>
 
 		<?php
-	}
-
-	/**
-	 * Returns a single subscription's columns.
-	 *
-	 * @param WPInv_Subscription $subscription
-	 *
-	 * @return array
-	 */
-	public function get_single_subscription_columns( $subscription ) {
-
-		// Prepare subscription detail columns.
-		$fields = apply_filters(
-			'getpaid_single_subscription_details_fields',
-			array(
-				'status'           => __( 'Status', 'invoicing' ),
-				'initial_amount'   => __( 'Initial amount', 'invoicing' ),
-				'recurring_amount' => __( 'Recurring amount', 'invoicing' ),
-				'start_date'       => __( 'Start date', 'invoicing' ),
-				'expiry_date'      => __( 'Next payment', 'invoicing' ),
-				'payments'         => __( 'Payments', 'invoicing' ),
-				'item'             => __( 'Item', 'invoicing' ),
-			),
-			$subscription
-		);
-
-		if ( ! $subscription->is_active() || $subscription->is_last_renewal() ) {
-			$fields['expiry_date'] = __( 'End date', 'invoicing' );
-		}
-
-		if ( $subscription->get_initial_amount() == $subscription->get_recurring_amount() ) {
-			unset( $fields['initial_amount'] );
-		}
-
-		return $fields;
-	}
-
-	/**
-	 * Displays a single subscription.
-	 *
-	 * @param string $subscription
-	 *
-	 * @return string
-	 */
-	public function display_single_subscription( $subscription ) {
-
-		// Fetch the subscription.
-		$subscription = new WPInv_Subscription( (int) $subscription );
-
-		if ( ! $subscription->get_id() ) {
-
-			return aui()->alert(
-				array(
-					'content' => wp_kses_post( __( 'Subscription not found.', 'invoicing' ) ),
-					'type'    => 'error',
-				)
-			);
-
-		}
-
-		// Ensure that the user owns this subscription key.
-		if ( get_current_user_id() != $subscription->get_customer_id() ) {
-
-			return aui()->alert(
-				array(
-					'content' => wp_kses_post( __( 'You do not have permission to view this subscription. Ensure that you are logged in to the account that owns the subscription.', 'invoicing' ) ),
-					'type'    => 'error',
-				)
-			);
-
-		}
-
-		return wpinv_get_template_html(
-			'subscriptions/subscription-details.php',
-			array(
-				'subscription' => $subscription,
-				'widget'       => $this
-			)
-		);
-
-	}
+    }
+
+    /**
+     * Returns a single subscription's columns.
+     *
+     * @param WPInv_Subscription $subscription
+     *
+     * @return array
+     */
+    public function get_single_subscription_columns( $subscription ) {
+
+        // Prepare subscription detail columns.
+        $fields = apply_filters(
+            'getpaid_single_subscription_details_fields',
+            array(
+                'status'           => __( 'Status', 'invoicing' ),
+                'initial_amount'   => __( 'Initial amount', 'invoicing' ),
+                'recurring_amount' => __( 'Recurring amount', 'invoicing' ),
+                'start_date'       => __( 'Start date', 'invoicing' ),
+                'expiry_date'      => __( 'Next payment', 'invoicing' ),
+                'payments'         => __( 'Payments', 'invoicing' ),
+                'item'             => __( 'Item', 'invoicing' ),
+            ),
+            $subscription
+        );
+
+        if ( ! $subscription->is_active() || $subscription->is_last_renewal() ) {
+            $fields['expiry_date'] = __( 'End date', 'invoicing' );
+        }
+
+        if ( $subscription->get_initial_amount() == $subscription->get_recurring_amount() ) {
+            unset( $fields['initial_amount'] );
+        }
+
+        return $fields;
+    }
+
+    /**
+     * Displays a single subscription.
+     *
+     * @param string $subscription
+     *
+     * @return string
+     */
+    public function display_single_subscription( $subscription ) {
+
+        // Fetch the subscription.
+        $subscription = new WPInv_Subscription( (int) $subscription );
+
+        if ( ! $subscription->get_id() ) {
+
+            return aui()->alert(
+                array(
+                    'content' => wp_kses_post( __( 'Subscription not found.', 'invoicing' ) ),
+                    'type'    => 'error',
+                )
+            );
+
+        }
+
+        // Ensure that the user owns this subscription key.
+        if ( get_current_user_id() != $subscription->get_customer_id() ) {
+
+            return aui()->alert(
+                array(
+                    'content' => wp_kses_post( __( 'You do not have permission to view this subscription. Ensure that you are logged in to the account that owns the subscription.', 'invoicing' ) ),
+                    'type'    => 'error',
+                )
+            );
+
+        }
+
+        return wpinv_get_template_html(
+            'subscriptions/subscription-details.php',
+            array(
+                'subscription' => $subscription,
+                'widget'       => $this
+            )
+        );
+
+    }
 
 }

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

Indentation +9 added lines, -9 removed lines

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

templates/invoice-history.php

Indentation +59 added lines, -59 removed lines

@@ -40,86 +40,86 @@ 
 				<tr class="wpinv-item wpinv-item-<?php echo $invoice_status = $invoice->get_status(); ?>">
 					<?php
 
-						foreach ( wpinv_get_user_invoices_columns() as $column_id => $column_name ) :
+                        foreach ( wpinv_get_user_invoices_columns() as $column_id => $column_name ) :
 
-							$column_id = sanitize_html_class( $column_id );
-							$class     = empty( $column_name['class'] ) ? '' : sanitize_html_class( $column_name['class'] );
+                            $column_id = sanitize_html_class( $column_id );
+                            $class     = empty( $column_name['class'] ) ? '' : sanitize_html_class( $column_name['class'] );
 
-							echo "<td class='$column_id $class'>";
-							switch ( $column_id ) {
+                            echo "<td class='$column_id $class'>";
+                            switch ( $column_id ) {
 
-								case 'invoice-number':
-									echo wpinv_invoice_link( $invoice );
-									break;
+                                case 'invoice-number':
+                                    echo wpinv_invoice_link( $invoice );
+                                    break;
 
-								case 'created-date':
-									echo getpaid_format_date_value( $invoice->get_date_created() );
-									break;
+                                case 'created-date':
+                                    echo getpaid_format_date_value( $invoice->get_date_created() );
+                                    break;
 
-								case 'payment-date':
+                                case 'payment-date':
 
-									if ( $invoice->needs_payment() ) {
-										echo "&mdash;";
-									} else {
-										echo getpaid_format_date_value( $invoice->get_date_completed() );
-									}
+                                    if ( $invoice->needs_payment() ) {
+                                        echo "&mdash;";
+                                    } else {
+                                        echo getpaid_format_date_value( $invoice->get_date_completed() );
+                                    }
 									
-									break;
+                                    break;
 
-								case 'invoice-status':
-									echo $invoice->get_status_label_html();
+                                case 'invoice-status':
+                                    echo $invoice->get_status_label_html();
 									
-									break;
+                                    break;
 
-								case 'invoice-total':
-									echo wpinv_price( wpinv_format_amount( $invoice->get_total() ) );
+                                case 'invoice-total':
+                                    echo wpinv_price( wpinv_format_amount( $invoice->get_total() ) );
 									
-									break;
+                                    break;
 
-								case 'invoice-actions':
+                                case 'invoice-actions':
 
-									$actions = array(
+                                    $actions = array(
 
-										'pay'       => array(
-											'url'   => $invoice->get_checkout_payment_url(),
-											'name'  => __( 'Pay Now', 'invoicing' ),
+                                        'pay'       => array(
+                                            'url'   => $invoice->get_checkout_payment_url(),
+                                            'name'  => __( 'Pay Now', 'invoicing' ),
                                             'class' => 'btn-success'
-										),
+                                        ),
 
                                         'print'     => array(
-											'url'   => $invoice->get_view_url(),
-											'name'  => __( 'View Invoice', 'invoicing' ),
+                                            'url'   => $invoice->get_view_url(),
+                                            'name'  => __( 'View Invoice', 'invoicing' ),
                                             'class' => 'btn-secondary',
                                             'attrs' => 'target="_blank"'
-										)
-									);
+                                        )
+                                    );
 
-									if ( ! $invoice->needs_payment() ) {
-										unset( $actions['pay'] );
-									}
+                                    if ( ! $invoice->needs_payment() ) {
+                                        unset( $actions['pay'] );
+                                    }
 
-									$actions = apply_filters( 'wpinv_user_invoices_actions', $actions, $invoice );
+                                    $actions = apply_filters( 'wpinv_user_invoices_actions', $actions, $invoice );
 
-									foreach ( $actions as $key => $action ) {
-										$class = !empty($action['class']) ? sanitize_html_class($action['class']) : '';
-										echo '<a href="' . esc_url( $action['url'] ) . '" class="btn btn-sm btn-block ' . $class . ' ' . sanitize_html_class( $key ) . '" ' . ( !empty($action['attrs']) ? $action['attrs'] : '' ) . '>' . $action['name'] . '</a>';
-									}
+                                    foreach ( $actions as $key => $action ) {
+                                        $class = !empty($action['class']) ? sanitize_html_class($action['class']) : '';
+                                        echo '<a href="' . esc_url( $action['url'] ) . '" class="btn btn-sm btn-block ' . $class . ' ' . sanitize_html_class( $key ) . '" ' . ( !empty($action['attrs']) ? $action['attrs'] : '' ) . '>' . $action['name'] . '</a>';
+                                    }
 									
-									break;
+                                    break;
 
-								default:
-									do_action( "wpinv_user_invoices_column_$column_id", $invoice );
-									break;
+                                default:
+                                    do_action( "wpinv_user_invoices_column_$column_id", $invoice );
+                                    break;
 
 								
-							}
+                            }
 
-							do_action( "wpinv_user_invoices_column_after_$column_id", $invoice );
+                            do_action( "wpinv_user_invoices_column_after_$column_id", $invoice );
 						
-							echo '</td>';
+                            echo '</td>';
 
-						endforeach;
-					?>
+                        endforeach;
+                    ?>
 				</tr>
 
 			<?php endforeach; ?>
@@ -132,14 +132,14 @@ 
 	<?php if ( 1 < $invoices->max_num_pages ) : ?>
 		<div class="invoicing-Pagination">
 			<?php
-			$big = 999999;
-
-			echo paginate_links( array(
-				'base'    => str_replace( $big, '%#%', esc_url( get_pagenum_link( $big ) ) ),
-				'format'  => '?paged=%#%',
-				'total'   => $invoices->max_num_pages,
-			) );
-			?>
+            $big = 999999;
+
+            echo paginate_links( array(
+                'base'    => str_replace( $big, '%#%', esc_url( get_pagenum_link( $big ) ) ),
+                'format'  => '?paged=%#%',
+                'total'   => $invoices->max_num_pages,
+            ) );
+            ?>
 		</div>
 	<?php endif; ?>
 

includes/admin/class-getpaid-metaboxes.php

Indentation +157 added lines, -157 removed lines

@@ -12,186 +12,186 @@
  */
 class GetPaid_Metaboxes {
 
-	/**
-	 * Only save metaboxes once.
-	 *
-	 * @var boolean
-	 */
-	private static $saved_meta_boxes = false;
+    /**
+     * Only save metaboxes once.
+     *
+     * @var boolean
+     */
+    private static $saved_meta_boxes = false;
 
     /**
-	 * Hook in methods.
-	 */
-	public static function init() {
-
-		// Register metaboxes.
-		add_action( 'add_meta_boxes', 'GetPaid_Metaboxes::add_meta_boxes', 5, 2 );
-
-		// Remove metaboxes.
-		add_action( 'add_meta_boxes', 'GetPaid_Metaboxes::remove_meta_boxes', 30 );
-
-		// Rename metaboxes.
-		add_action( 'add_meta_boxes', 'GetPaid_Metaboxes::rename_meta_boxes', 45 );
-
-		// Save metaboxes.
-		add_action( 'save_post', 'GetPaid_Metaboxes::save_meta_boxes', 1, 2 );
-	}
-
-	/**
-	 * Register core metaboxes.
-	 */
-	public static function add_meta_boxes( $post_type, $post ) {
-		global $wpinv_euvat;
-
-		// For invoices...
-		if ( $post_type == 'wpi_invoice' ) {
-			$invoice = new WPInv_Invoice( $post );
-
-			// Resend invoice.
-			if ( ! $invoice->is_draft() && ! $invoice->is_paid() ) {
-				add_meta_box( 'wpinv-mb-resend-invoice', __( 'Resend Invoice', 'invoicing' ), 'GetPaid_Meta_Box_Resend_Invoice::output', 'wpi_invoice', 'side', 'low' );
-			}
-
-			// Subscriptions.
-			$subscription = getpaid_get_invoice_subscription( $invoice );
-			if ( ! empty( $subscription ) ) {
-				add_meta_box( 'wpinv-mb-subscriptions', __( 'Subscription Details', 'invoicing' ), 'GetPaid_Meta_Box_Invoice_Subscription::output', 'wpi_invoice', 'advanced' );
-				add_meta_box( 'wpinv-mb-subscription-invoices', __( 'Related Payments', 'invoicing' ), 'GetPaid_Meta_Box_Invoice_Subscription::output_invoices', 'wpi_invoice', 'advanced' );
-			}
-
-			// Invoice details.
-			add_meta_box( 'wpinv-details', __( 'Invoice Details', 'invoicing' ), 'GetPaid_Meta_Box_Invoice_Details::output', 'wpi_invoice', 'side', 'default' );
+     * Hook in methods.
+     */
+    public static function init() {
+
+        // Register metaboxes.
+        add_action( 'add_meta_boxes', 'GetPaid_Metaboxes::add_meta_boxes', 5, 2 );
+
+        // Remove metaboxes.
+        add_action( 'add_meta_boxes', 'GetPaid_Metaboxes::remove_meta_boxes', 30 );
+
+        // Rename metaboxes.
+        add_action( 'add_meta_boxes', 'GetPaid_Metaboxes::rename_meta_boxes', 45 );
+
+        // Save metaboxes.
+        add_action( 'save_post', 'GetPaid_Metaboxes::save_meta_boxes', 1, 2 );
+    }
+
+    /**
+     * Register core metaboxes.
+     */
+    public static function add_meta_boxes( $post_type, $post ) {
+        global $wpinv_euvat;
+
+        // For invoices...
+        if ( $post_type == 'wpi_invoice' ) {
+            $invoice = new WPInv_Invoice( $post );
+
+            // Resend invoice.
+            if ( ! $invoice->is_draft() && ! $invoice->is_paid() ) {
+                add_meta_box( 'wpinv-mb-resend-invoice', __( 'Resend Invoice', 'invoicing' ), 'GetPaid_Meta_Box_Resend_Invoice::output', 'wpi_invoice', 'side', 'low' );
+            }
+
+            // Subscriptions.
+            $subscription = getpaid_get_invoice_subscription( $invoice );
+            if ( ! empty( $subscription ) ) {
+                add_meta_box( 'wpinv-mb-subscriptions', __( 'Subscription Details', 'invoicing' ), 'GetPaid_Meta_Box_Invoice_Subscription::output', 'wpi_invoice', 'advanced' );
+                add_meta_box( 'wpinv-mb-subscription-invoices', __( 'Related Payments', 'invoicing' ), 'GetPaid_Meta_Box_Invoice_Subscription::output_invoices', 'wpi_invoice', 'advanced' );
+            }
+
+            // Invoice details.
+            add_meta_box( 'wpinv-details', __( 'Invoice Details', 'invoicing' ), 'GetPaid_Meta_Box_Invoice_Details::output', 'wpi_invoice', 'side', 'default' );
 			
-			// Payment details.
-			if ( ! $invoice->is_draft() ) {
-				add_meta_box( 'wpinv-payment-meta', __( 'Payment Meta', 'invoicing' ), 'GetPaid_Meta_Box_Invoice_Payment_Meta::output', 'wpi_invoice', 'side', 'default' );
-			}
+            // Payment details.
+            if ( ! $invoice->is_draft() ) {
+                add_meta_box( 'wpinv-payment-meta', __( 'Payment Meta', 'invoicing' ), 'GetPaid_Meta_Box_Invoice_Payment_Meta::output', 'wpi_invoice', 'side', 'default' );
+            }
 
-			// Billing details.
-			add_meta_box( 'wpinv-address', __( 'Billing Details', 'invoicing' ), 'GetPaid_Meta_Box_Invoice_Address::output', 'wpi_invoice', 'normal', 'high' );
+            // Billing details.
+            add_meta_box( 'wpinv-address', __( 'Billing Details', 'invoicing' ), 'GetPaid_Meta_Box_Invoice_Address::output', 'wpi_invoice', 'normal', 'high' );
 			
-			// Invoice items.
-			add_meta_box( 'wpinv-items', __( 'Invoice Items', 'invoicing' ), 'GetPaid_Meta_Box_Invoice_Items::output', 'wpi_invoice', 'normal', 'high' );
+            // Invoice items.
+            add_meta_box( 'wpinv-items', __( 'Invoice Items', 'invoicing' ), 'GetPaid_Meta_Box_Invoice_Items::output', 'wpi_invoice', 'normal', 'high' );
 			
-			// Invoice notes.
-			add_meta_box( 'wpinv-notes', __( 'Invoice Notes', 'invoicing' ), 'WPInv_Meta_Box_Notes::output', 'wpi_invoice', 'side', 'low' );
+            // Invoice notes.
+            add_meta_box( 'wpinv-notes', __( 'Invoice Notes', 'invoicing' ), 'WPInv_Meta_Box_Notes::output', 'wpi_invoice', 'side', 'low' );
 
-			// Payment form information.
-			if ( ! empty( $post->ID ) && get_post_meta( $post->ID, 'payment_form_data', true ) ) {
-				add_meta_box( 'wpinv-invoice-payment-form-details', __( 'Payment Form Details', 'invoicing' ), 'WPInv_Meta_Box_Payment_Form::output_details', 'wpi_invoice', 'side', 'high' );
-			}
-		}
+            // Payment form information.
+            if ( ! empty( $post->ID ) && get_post_meta( $post->ID, 'payment_form_data', true ) ) {
+                add_meta_box( 'wpinv-invoice-payment-form-details', __( 'Payment Form Details', 'invoicing' ), 'WPInv_Meta_Box_Payment_Form::output_details', 'wpi_invoice', 'side', 'high' );
+            }
+        }
 
-		// For payment forms.
-		if ( $post_type == 'wpi_payment_form' ) {
+        // For payment forms.
+        if ( $post_type == 'wpi_payment_form' ) {
 
-			// Design payment form.
-			add_meta_box( 'wpinv-payment-form-design', __( 'Payment Form', 'invoicing' ), 'GetPaid_Meta_Box_Payment_Form::output', 'wpi_payment_form', 'normal' );
+            // Design payment form.
+            add_meta_box( 'wpinv-payment-form-design', __( 'Payment Form', 'invoicing' ), 'GetPaid_Meta_Box_Payment_Form::output', 'wpi_payment_form', 'normal' );
 
-			// Payment form information.
-			add_meta_box( 'wpinv-payment-form-info', __( 'Details', 'invoicing' ), 'GetPaid_Meta_Box_Payment_Form_Info::output', 'wpi_payment_form', 'side' );
+            // Payment form information.
+            add_meta_box( 'wpinv-payment-form-info', __( 'Details', 'invoicing' ), 'GetPaid_Meta_Box_Payment_Form_Info::output', 'wpi_payment_form', 'side' );
 
-		}
+        }
 
-		// For invoice items.
-		if ( $post_type == 'wpi_item' ) {
+        // For invoice items.
+        if ( $post_type == 'wpi_item' ) {
 
-			// Item details.
-			add_meta_box( 'wpinv_item_details', __( 'Item Details', 'invoicing' ), 'GetPaid_Meta_Box_Item_Details::output', 'wpi_item', 'normal', 'high' );
+            // Item details.
+            add_meta_box( 'wpinv_item_details', __( 'Item Details', 'invoicing' ), 'GetPaid_Meta_Box_Item_Details::output', 'wpi_item', 'normal', 'high' );
 
-			// If taxes are enabled, register the tax metabox.
-			if ( $wpinv_euvat->allow_vat_rules() || $wpinv_euvat->allow_vat_classes() ) {
-				add_meta_box( 'wpinv_item_vat', __( 'VAT / Tax', 'invoicing' ), 'GetPaid_Meta_Box_Item_VAT::output', 'wpi_item', 'normal', 'high' );
-			}
+            // If taxes are enabled, register the tax metabox.
+            if ( $wpinv_euvat->allow_vat_rules() || $wpinv_euvat->allow_vat_classes() ) {
+                add_meta_box( 'wpinv_item_vat', __( 'VAT / Tax', 'invoicing' ), 'GetPaid_Meta_Box_Item_VAT::output', 'wpi_item', 'normal', 'high' );
+            }
 
-			// Item info.
-			add_meta_box( 'wpinv_field_item_info', __( 'Item info', 'invoicing' ), 'GetPaid_Meta_Box_Item_Info::output', 'wpi_item', 'side', 'core' );
+            // Item info.
+            add_meta_box( 'wpinv_field_item_info', __( 'Item info', 'invoicing' ), 'GetPaid_Meta_Box_Item_Info::output', 'wpi_item', 'side', 'core' );
 
-		}
+        }
 
-		// For invoice discounts.
-		if ( $post_type == 'wpi_discount' ) {
-			add_meta_box( 'wpinv_discount_details', __( 'Discount Details', 'invoicing' ), 'GetPaid_Meta_Box_Discount_Details::output', 'wpi_discount', 'normal', 'high' );
-		}
+        // For invoice discounts.
+        if ( $post_type == 'wpi_discount' ) {
+            add_meta_box( 'wpinv_discount_details', __( 'Discount Details', 'invoicing' ), 'GetPaid_Meta_Box_Discount_Details::output', 'wpi_discount', 'normal', 'high' );
+        }
 		
 
-	}
+    }
 
-	/**
-	 * Remove some metaboxes.
-	 */
-	public static function remove_meta_boxes() {
-		remove_meta_box( 'wpseo_meta', 'wpi_invoice', 'normal' );
-	}
+    /**
+     * Remove some metaboxes.
+     */
+    public static function remove_meta_boxes() {
+        remove_meta_box( 'wpseo_meta', 'wpi_invoice', 'normal' );
+    }
 
-	/**
-	 * Rename other metaboxes.
-	 */
-	public static function rename_meta_boxes() {
+    /**
+     * Rename other metaboxes.
+     */
+    public static function rename_meta_boxes() {
 		
-	}
-
-	/**
-	 * Check if we're saving, then trigger an action based on the post type.
-	 *
-	 * @param  int    $post_id Post ID.
-	 * @param  object $post Post object.
-	 */
-	public static function save_meta_boxes( $post_id, $post ) {
-		$post_id = absint( $post_id );
-		$data    = wp_unslash( $_POST );
-
-		// Do not save for ajax requests.
-		if ( ( defined( 'DOING_AJAX') && DOING_AJAX ) || isset( $_REQUEST['bulk_edit'] ) ) {
-			return;
-		}
-
-		// $post_id and $post are required
-		if ( empty( $post_id ) || empty( $post ) || self::$saved_meta_boxes ) {
-			return;
-		}
-
-		// Dont' save meta boxes for revisions or autosaves.
-		if ( ( defined( 'DOING_AUTOSAVE' ) && DOING_AUTOSAVE ) || is_int( wp_is_post_revision( $post ) ) || is_int( wp_is_post_autosave( $post ) ) ) {
-			return;
-		}
-
-		// Check the nonce.
-		if ( empty( $data['getpaid_meta_nonce'] ) || ! wp_verify_nonce( $data['getpaid_meta_nonce'], 'getpaid_meta_nonce' ) ) {
-			return;
-		}
-
-		// Check the post being saved == the $post_id to prevent triggering this call for other save_post events.
-		if ( empty( $data['post_ID'] ) || absint( $data['post_ID'] ) !== $post_id ) {
-			return;
-		}
-
-		// Check user has permission to edit.
-		if ( ! current_user_can( 'edit_post', $post_id ) ) {
-			return;
-		}
-
-		// Ensure this is our post type.
-		$post_types_map = array(
-			'wpi_invoice'      => 'GetPaid_Meta_Box_Invoice_Address',
-			'wpi_quote'        => 'GetPaid_Meta_Box_Invoice_Address',
-			'wpi_item'         => 'GetPaid_Meta_Box_Item_Details',
-			'wpi_payment_form' => 'GetPaid_Meta_Box_Payment_Form',
-			'wpi_discount'     => 'GetPaid_Meta_Box_Discount_Details',
-		);
-
-		// Is this our post type?
-		if ( empty( $post->post_type ) || ! isset( $post_types_map[ $post->post_type ] ) ) {
-			return;
-		}
-
-		// We need this save event to run once to avoid potential endless loops.
-		self::$saved_meta_boxes = true;
+    }
+
+    /**
+     * Check if we're saving, then trigger an action based on the post type.
+     *
+     * @param  int    $post_id Post ID.
+     * @param  object $post Post object.
+     */
+    public static function save_meta_boxes( $post_id, $post ) {
+        $post_id = absint( $post_id );
+        $data    = wp_unslash( $_POST );
+
+        // Do not save for ajax requests.
+        if ( ( defined( 'DOING_AJAX') && DOING_AJAX ) || isset( $_REQUEST['bulk_edit'] ) ) {
+            return;
+        }
+
+        // $post_id and $post are required
+        if ( empty( $post_id ) || empty( $post ) || self::$saved_meta_boxes ) {
+            return;
+        }
+
+        // Dont' save meta boxes for revisions or autosaves.
+        if ( ( defined( 'DOING_AUTOSAVE' ) && DOING_AUTOSAVE ) || is_int( wp_is_post_revision( $post ) ) || is_int( wp_is_post_autosave( $post ) ) ) {
+            return;
+        }
+
+        // Check the nonce.
+        if ( empty( $data['getpaid_meta_nonce'] ) || ! wp_verify_nonce( $data['getpaid_meta_nonce'], 'getpaid_meta_nonce' ) ) {
+            return;
+        }
+
+        // Check the post being saved == the $post_id to prevent triggering this call for other save_post events.
+        if ( empty( $data['post_ID'] ) || absint( $data['post_ID'] ) !== $post_id ) {
+            return;
+        }
+
+        // Check user has permission to edit.
+        if ( ! current_user_can( 'edit_post', $post_id ) ) {
+            return;
+        }
+
+        // Ensure this is our post type.
+        $post_types_map = array(
+            'wpi_invoice'      => 'GetPaid_Meta_Box_Invoice_Address',
+            'wpi_quote'        => 'GetPaid_Meta_Box_Invoice_Address',
+            'wpi_item'         => 'GetPaid_Meta_Box_Item_Details',
+            'wpi_payment_form' => 'GetPaid_Meta_Box_Payment_Form',
+            'wpi_discount'     => 'GetPaid_Meta_Box_Discount_Details',
+        );
+
+        // Is this our post type?
+        if ( empty( $post->post_type ) || ! isset( $post_types_map[ $post->post_type ] ) ) {
+            return;
+        }
+
+        // We need this save event to run once to avoid potential endless loops.
+        self::$saved_meta_boxes = true;
 		
-		// Save the post.
-		$class = $post_types_map[ $post->post_type ];
-		$class::save( $post_id, $_POST, $post );
+        // Save the post.
+        $class = $post_types_map[ $post->post_type ];
+        $class::save( $post_id, $_POST, $post );
 
-	}
+    }
 
 }

includes/subscription-functions.php

Indentation +146 added lines, -146 removed lines

@@ -17,28 +17,28 @@ 
  */
 function getpaid_get_subscriptions( $args = array(), $return = 'results' ) {
 
-	// Do not retrieve all fields if we just want the count.
-	if ( 'count' == $return ) {
-		$args['fields'] = 'id';
-		$args['number'] = 1;
-	}
+    // Do not retrieve all fields if we just want the count.
+    if ( 'count' == $return ) {
+        $args['fields'] = 'id';
+        $args['number'] = 1;
+    }
 
-	// Do not count all matches if we just want the results.
-	if ( 'results' == $return ) {
-		$args['count_total'] = false;
-	}
+    // Do not count all matches if we just want the results.
+    if ( 'results' == $return ) {
+        $args['count_total'] = false;
+    }
 
-	$query = new GetPaid_Subscriptions_Query( $args );
+    $query = new GetPaid_Subscriptions_Query( $args );
 
-	if ( 'results' == $return ) {
-		return $query->get_results();
-	}
+    if ( 'results' == $return ) {
+        return $query->get_results();
+    }
 
-	if ( 'count' == $return ) {
-		return $query->get_total();
-	}
+    if ( 'count' == $return ) {
+        return $query->get_total();
+    }
 
-	return $query;
+    return $query;
 }
 
 /**
@@ -48,18 +48,18 @@ 
  */
 function getpaid_get_subscription_statuses() {
 
-	return apply_filters(
-		'getpaid_get_subscription_statuses',
-		array(
-			'pending'    => __( 'Pending', 'invoicing' ),
-			'trialling'  => __( 'Trialing', 'invoicing' ),
-			'active'     => __( 'Active', 'invoicing' ),
-			'failing'    => __( 'Failing', 'invoicing' ),
-			'expired'    => __( 'Expired', 'invoicing' ),
-			'completed'  => __( 'Complete', 'invoicing' ),
-			'cancelled'  => __( 'Cancelled', 'invoicing' ),
-		)
-	);
+    return apply_filters(
+        'getpaid_get_subscription_statuses',
+        array(
+            'pending'    => __( 'Pending', 'invoicing' ),
+            'trialling'  => __( 'Trialing', 'invoicing' ),
+            'active'     => __( 'Active', 'invoicing' ),
+            'failing'    => __( 'Failing', 'invoicing' ),
+            'expired'    => __( 'Expired', 'invoicing' ),
+            'completed'  => __( 'Complete', 'invoicing' ),
+            'cancelled'  => __( 'Cancelled', 'invoicing' ),
+        )
+    );
 
 }
 
@@ -69,8 +69,8 @@ 
  * @return string
  */
 function getpaid_get_subscription_status_label( $status ) {
-	$statuses = getpaid_get_subscription_statuses();
-	return isset( $statuses[ $status ] ) ? $statuses[ $status ] : ucfirst( sanitize_text_field( $status ) );
+    $statuses = getpaid_get_subscription_statuses();
+    return isset( $statuses[ $status ] ) ? $statuses[ $status ] : ucfirst( sanitize_text_field( $status ) );
 }
 
 /**
@@ -80,18 +80,18 @@ 
  */
 function getpaid_get_subscription_status_classes() {
 
-	return apply_filters(
-		'getpaid_get_subscription_status_classes',
-		array(
-			'pending'    => 'getpaid-item-status-pending',
-			'trialling'  => 'getpaid-item-status-trial',
-			'active'     => 'getpaid-item-status-info',
-			'failing'    => 'getpaid-item-status-failing',
-			'expired'    => 'getpaid-item-status-expired',
-			'completed'  => 'getpaid-item-status-success',
-			'cancelled'  => 'getpaid-item-status-canceled',
-		)
-	);
+    return apply_filters(
+        'getpaid_get_subscription_status_classes',
+        array(
+            'pending'    => 'getpaid-item-status-pending',
+            'trialling'  => 'getpaid-item-status-trial',
+            'active'     => 'getpaid-item-status-info',
+            'failing'    => 'getpaid-item-status-failing',
+            'expired'    => 'getpaid-item-status-expired',
+            'completed'  => 'getpaid-item-status-success',
+            'cancelled'  => 'getpaid-item-status-canceled',
+        )
+    );
 
 }
 
@@ -102,15 +102,15 @@ 
  */
 function getpaid_get_subscription_status_counts( $args = array() ) {
 
-	$statuses = array_keys( getpaid_get_subscription_statuses() );
-	$counts   = array();
+    $statuses = array_keys( getpaid_get_subscription_statuses() );
+    $counts   = array();
 
-	foreach ( $statuses as $status ) {
-		$_args             = wp_parse_args( "status=$status", $args );
-		$counts[ $status ] = getpaid_get_subscriptions( $_args, 'count' );
-	}
+    foreach ( $statuses as $status ) {
+        $_args             = wp_parse_args( "status=$status", $args );
+        $counts[ $status ] = getpaid_get_subscriptions( $_args, 'count' );
+    }
 
-	return $counts;
+    return $counts;
 
 }
 
@@ -121,32 +121,32 @@ 
  */
 function getpaid_get_subscription_periods() {
 
-	return apply_filters(
-		'getpaid_get_subscription_periods',
-		array(
+    return apply_filters(
+        'getpaid_get_subscription_periods',
+        array(
 
-			'day'   => array(
-				'singular' => __( '%s day', 'invoicing' ),
-				'plural'   => __( '%d days', 'invoicing' ),
-			),
+            'day'   => array(
+                'singular' => __( '%s day', 'invoicing' ),
+                'plural'   => __( '%d days', 'invoicing' ),
+            ),
 
-			'week'   => array(
-				'singular' => __( '%s week', 'invoicing' ),
-				'plural'   => __( '%d weeks', 'invoicing' ),
-			),
+            'week'   => array(
+                'singular' => __( '%s week', 'invoicing' ),
+                'plural'   => __( '%d weeks', 'invoicing' ),
+            ),
 
-			'month'   => array(
-				'singular' => __( '%s month', 'invoicing' ),
-				'plural'   => __( '%d months', 'invoicing' ),
-			),
+            'month'   => array(
+                'singular' => __( '%s month', 'invoicing' ),
+                'plural'   => __( '%d months', 'invoicing' ),
+            ),
 
-			'year'   => array(
-				'singular' => __( '%s year', 'invoicing' ),
-				'plural'   => __( '%d years', 'invoicing' ),
-			),
+            'year'   => array(
+                'singular' => __( '%s year', 'invoicing' ),
+                'plural'   => __( '%d years', 'invoicing' ),
+            ),
 
-		)
-	);
+        )
+    );
 
 }
 
@@ -157,7 +157,7 @@ 
  * @return int
  */
 function getpaid_get_subscription_trial_period_interval( $trial_period ) {
-	return (int) preg_replace( '/[^0-9]/', '', $trial_period );
+    return (int) preg_replace( '/[^0-9]/', '', $trial_period );
 }
 
 /**
@@ -167,7 +167,7 @@ 
  * @return string
  */
 function getpaid_get_subscription_trial_period_period( $trial_period ) {
-	return preg_replace( '/[^a-z]/', '', strtolower( $trial_period ) );
+    return preg_replace( '/[^a-z]/', '', strtolower( $trial_period ) );
 }
 
 /**
@@ -178,8 +178,8 @@ 
  * @return string
  */
 function getpaid_get_subscription_period_label( $period, $interval = 1, $singular_prefix = '1' ) {
-	$label = (int) $interval > 1 ? getpaid_get_plural_subscription_period_label(  $period, $interval ) : getpaid_get_singular_subscription_period_label( $period, $singular_prefix );
-	return strtolower( sanitize_text_field( $label ) );
+    $label = (int) $interval > 1 ? getpaid_get_plural_subscription_period_label(  $period, $interval ) : getpaid_get_singular_subscription_period_label( $period, $singular_prefix );
+    return strtolower( sanitize_text_field( $label ) );
 }
 
 /**
@@ -190,22 +190,22 @@ 
  */
 function getpaid_get_singular_subscription_period_label( $period, $singular_prefix = '1' ) {
 
-	$periods = getpaid_get_subscription_periods();
-	$period  = strtolower( $period );
+    $periods = getpaid_get_subscription_periods();
+    $period  = strtolower( $period );
 
-	if ( isset( $periods[ $period ] ) ) {
-		return sprintf( $periods[ $period ]['singular'], $singular_prefix );
-	}
+    if ( isset( $periods[ $period ] ) ) {
+        return sprintf( $periods[ $period ]['singular'], $singular_prefix );
+    }
 
-	// Backwards compatibility.
-	foreach ( $periods as $key => $data ) {
-		if ( strpos( $key, $period ) === 0 ) {
-			return sprintf( $data['singular'], $singular_prefix );
-		}
-	}
+    // Backwards compatibility.
+    foreach ( $periods as $key => $data ) {
+        if ( strpos( $key, $period ) === 0 ) {
+            return sprintf( $data['singular'], $singular_prefix );
+        }
+    }
 
-	// Invalid string.
-	return '';
+    // Invalid string.
+    return '';
 }
 
 /**
@@ -217,22 +217,22 @@ 
  */
 function getpaid_get_plural_subscription_period_label( $period, $interval ) {
 
-	$periods = getpaid_get_subscription_periods();
-	$period  = strtolower( $period );
+    $periods = getpaid_get_subscription_periods();
+    $period  = strtolower( $period );
 
-	if ( isset( $periods[ $period ] ) ) {
-		return sprintf( $periods[ $period ]['plural'], $interval );
-	}
+    if ( isset( $periods[ $period ] ) ) {
+        return sprintf( $periods[ $period ]['plural'], $interval );
+    }
 
-	// Backwards compatibility.
-	foreach ( $periods as $key => $data ) {
-		if ( strpos( $key, $period ) === 0 ) {
-			return sprintf( $data['plural'], $interval );
-		}
-	}
+    // Backwards compatibility.
+    foreach ( $periods as $key => $data ) {
+        if ( strpos( $key, $period ) === 0 ) {
+            return sprintf( $data['plural'], $interval );
+        }
+    }
 
-	// Invalid string.
-	return '';
+    // Invalid string.
+    return '';
 }
 
 /**
@@ -243,50 +243,50 @@ 
  */
 function getpaid_get_formatted_subscription_amount( $subscription ) {
 
-	$initial   = wpinv_price( wpinv_format_amount( $subscription->get_initial_amount() ), $subscription->get_parent_payment()->get_currency() );
-	$recurring = wpinv_price( wpinv_format_amount( $subscription->get_recurring_amount() ), $subscription->get_parent_payment()->get_currency() );
-	$period    = getpaid_get_subscription_period_label( $subscription->get_period(), $subscription->get_frequency(), '' );
+    $initial   = wpinv_price( wpinv_format_amount( $subscription->get_initial_amount() ), $subscription->get_parent_payment()->get_currency() );
+    $recurring = wpinv_price( wpinv_format_amount( $subscription->get_recurring_amount() ), $subscription->get_parent_payment()->get_currency() );
+    $period    = getpaid_get_subscription_period_label( $subscription->get_period(), $subscription->get_frequency(), '' );
 
-	// Trial periods.
-	if ( $subscription->has_trial_period() ) {
+    // Trial periods.
+    if ( $subscription->has_trial_period() ) {
 
-		$trial_period   = getpaid_get_subscription_trial_period_period( $subscription->get_trial_period() );
-		$trial_interval = getpaid_get_subscription_trial_period_interval( $subscription->get_trial_period() );
-		return sprintf(
+        $trial_period   = getpaid_get_subscription_trial_period_period( $subscription->get_trial_period() );
+        $trial_interval = getpaid_get_subscription_trial_period_interval( $subscription->get_trial_period() );
+        return sprintf(
 
-			// translators: $1: is the initial amount, $2: is the trial period, $3: is the recurring amount, $4: is the recurring period
-			_x( '%1$s trial for %2$s then %3$s / %4$s', 'Subscription amount. (e.g.: $10 trial for 1 month then $120 / year)', 'invoicing' ),
-			$initial,
-			getpaid_get_subscription_period_label( $trial_period, $trial_interval ),
-			$recurring,
-			$period
+            // translators: $1: is the initial amount, $2: is the trial period, $3: is the recurring amount, $4: is the recurring period
+            _x( '%1$s trial for %2$s then %3$s / %4$s', 'Subscription amount. (e.g.: $10 trial for 1 month then $120 / year)', 'invoicing' ),
+            $initial,
+            getpaid_get_subscription_period_label( $trial_period, $trial_interval ),
+            $recurring,
+            $period
 
-		);
+        );
 
-	}
+    }
 
-	if ( $initial != $recurring ) {
+    if ( $initial != $recurring ) {
 
-		return sprintf(
+        return sprintf(
 
-			// translators: $1: is the initial amount, $2: is the recurring amount, $3: is the recurring period
-			_x( 'Initial payment of %1$s which renews at %2$s / %3$s', 'Subscription amount. (e.g.:Initial payment of $100 which renews at $120 / year)', 'invoicing' ),
-			$initial,
-			$recurring,
-			$period
+            // translators: $1: is the initial amount, $2: is the recurring amount, $3: is the recurring period
+            _x( 'Initial payment of %1$s which renews at %2$s / %3$s', 'Subscription amount. (e.g.:Initial payment of $100 which renews at $120 / year)', 'invoicing' ),
+            $initial,
+            $recurring,
+            $period
 
-		);
+        );
 
-	}
+    }
 
-	return sprintf(
+    return sprintf(
 
-		// translators: $1: is the recurring amount, $2: is the recurring period
-		_x( '%1$s / %2$s', 'Subscription amount. (e.g.: $120 / year)', 'invoicing' ),
-		$initial,
-		$period
+        // translators: $1: is the recurring amount, $2: is the recurring period
+        _x( '%1$s / %2$s', 'Subscription amount. (e.g.: $120 / year)', 'invoicing' ),
+        $initial,
+        $period
 
-	);
+    );
 
 }
 
@@ -297,7 +297,7 @@ 
  * @return WPInv_Subscription|bool
  */
 function getpaid_get_invoice_subscription( $invoice ) {
-	return getpaid_subscriptions()->get_invoice_subscription( $invoice );
+    return getpaid_subscriptions()->get_invoice_subscription( $invoice );
 }
 
 /**
@@ -306,10 +306,10 @@ 
  * @param WPInv_Invoice $invoice
  */
 function getpaid_activate_invoice_subscription( $invoice ) {
-	$subscription = getpaid_get_invoice_subscription( $invoice );
-	if ( is_a( $subscription, 'WPInv_Subscription' ) ) {
-		$subscription->activate();
-	}
+    $subscription = getpaid_get_invoice_subscription( $invoice );
+    if ( is_a( $subscription, 'WPInv_Subscription' ) ) {
+        $subscription->activate();
+    }
 }
 
 /**
@@ -318,7 +318,7 @@ 
  * @return WPInv_Subscriptions
  */
 function getpaid_subscriptions() {
-	return getpaid()->get( 'subscriptions' );
+    return getpaid()->get( 'subscriptions' );
 }
 
 /**
@@ -336,14 +336,14 @@ 
         return false;
     }
 
-	// Fetch the invoiec subscription.
-	$subscription = getpaid_get_subscriptions(
-		array(
-			'invoice_in' => $invoice->is_renewal() ? $invoice->get_parent_id() : $invoice->get_id(),
-			'number'     => 1,
-		)
-	);
+    // Fetch the invoiec subscription.
+    $subscription = getpaid_get_subscriptions(
+        array(
+            'invoice_in' => $invoice->is_renewal() ? $invoice->get_parent_id() : $invoice->get_id(),
+            'number'     => 1,
+        )
+    );
 
-	return empty( $subscription ) ? false : $subscription[0];
+    return empty( $subscription ) ? false : $subscription[0];
 
 }

includes/class-getpaid-invoice-notification-emails.php

Indentation +386 added lines, -386 removed lines

@@ -12,438 +12,438 @@
  */
 class GetPaid_Invoice_Notification_Emails {
 
-	/**
-	 * The array of invoice email actions.
-	 *
-	 * @param array
-	 */
-	public $invoice_actions;
-
-	/**
-	 * Class constructor
-	 *
-	 */
-	public function __construct() {
-
-		$this->invoice_actions = apply_filters(
-			'getpaid_notification_email_invoice_triggers',
-			array(
-				'getpaid_new_invoice'                   => array( 'new_invoice', 'user_invoice' ),
-				'getpaid_invoice_status_wpi-cancelled'  => 'cancelled_invoice',
-				'getpaid_invoice_status_wpi-failed'     => 'failed_invoice',
-				'getpaid_invoice_status_wpi-onhold'     => 'onhold_invoice',
-				'getpaid_invoice_status_wpi-processing' => 'processing_invoice',
-				'getpaid_invoice_status_publish'        => 'completed_invoice',
-				'getpaid_invoice_status_wpi-renewal'    => 'completed_invoice',
-				'getpaid_invoice_status_wpi-refunded'   => 'refunded_invoice',
-				'getpaid_new_customer_note'             => 'user_note',
-				'getpaid_daily_maintenance'             => 'overdue',
-			)
-		);
-
-		$this->init_hooks();
-
-	}
-
-	/**
-	 * Registers email hooks.
-	 */
-	public function init_hooks() {
-
-		add_filter( 'getpaid_get_email_merge_tags', array( $this, 'invoice_merge_tags' ), 10, 2 );
-		add_filter( 'getpaid_invoice_email_recipients', array( $this, 'filter_email_recipients' ), 10, 2 );
-
-		foreach ( $this->invoice_actions as $hook => $email_type ) {
-			$this->init_email_type_hook( $hook, $email_type );
-		}
-	}
-
-	/**
-	 * Registers an email hook for an invoice action.
-	 * 
-	 * @param string $hook
-	 * @param string|array $email_type
-	 */
-	public function init_email_type_hook( $hook, $email_type ) {
-
-		$email_type = wpinv_parse_list( $email_type );
-
-		foreach ( $email_type as $type ) {
-
-			$email = new GetPaid_Notification_Email( $type );
-
-			// Abort if it is not active.
-			if ( ! $email->is_active() ) {
-				continue;
-			}
-
-			if ( method_exists( $this, $type ) ) {
-				add_action( $hook, array( $this, $type ), 100, 2 );
-				continue;
-			}
-
-			do_action( 'getpaid_invoice_init_email_type_hook', $type );
-		}
-
-	}
-
-	/**
-	 * Filters invoice merge tags.
-	 *
-	 * @param array $merge_tags
-	 * @param mixed|WPInv_Invoice|WPInv_Subscription $object
-	 */
-	public function invoice_merge_tags( $merge_tags, $object ) {
-
-		if ( is_a( $object, 'WPInv_Invoice' ) ) {
-			return array_merge(
-				$merge_tags,
-				$this->get_invoice_merge_tags( $object )
-			);
-		}
-
-		if ( is_a( $object, 'WPInv_Subscription' ) ) {
-			return array_merge(
-				$merge_tags,
-				$this->get_invoice_merge_tags( $object->get_parent_payment() )
-			);
-		}
-
-		return $merge_tags;
-
-	}
-
-	/**
-	 * Generates invoice merge tags.
-	 *
-	 * @param WPInv_Invoice $invoice
-	 * @return array
-	 */
-	public function get_invoice_merge_tags( $invoice ) {
-
-		// Abort if it does not exist.
-		if ( ! $invoice->get_id() ) {
-			return array();
-		}
-
-		return array(
-			'{name}'                => sanitize_text_field( $invoice->get_user_full_name() ),
-			'{full_name}'           => sanitize_text_field( $invoice->get_user_full_name() ),
-			'{first_name}'          => sanitize_text_field( $invoice->get_first_name() ),
-			'{last_name}'           => sanitize_text_field( $invoice->get_last_name() ),
-			'{email}'               => sanitize_email( $invoice->get_email() ),
-			'{invoice_number}'      => sanitize_text_field( $invoice->get_number() ),
-			'{invoice_currency}'    => sanitize_text_field( $invoice->get_currency() ),
-			'{invoice_total}'       => wpinv_price( wpinv_format_amount( $invoice->get_total() ) ),
-			'{invoice_link}'        => esc_url( $invoice->get_view_url() ),
-			'{invoice_pay_link}'    => esc_url( $invoice->get_checkout_payment_url() ),
-			'{invoice_receipt_link}'=> esc_url( $invoice->get_receipt_url() ),
-			'{invoice_date}'        => getpaid_format_date_value( $invoice->get_date_created() ),
-			'{invoice_due_date}'    => getpaid_format_date_value( $invoice->get_due_date(), __( 'on receipt', 'invoicing' ) ),
-			'{invoice_quote}'       => sanitize_text_field( $invoice->get_type() ),
-			'{invoice_label}'       => sanitize_text_field( ucfirst( $invoice->get_type() ) ),
-			'{invoice_description}' => wp_kses_post( $invoice->get_description() ),
-			'{subscription_name}'   => wp_kses_post( $invoice->get_subscription_name() ),
-			'{is_was}'              => strtotime( $invoice->get_due_date() ) < current_time( 'timestamp' ) ? __( 'was', 'invoicing' ) : __( 'is', 'invoicing' ),
-		);
-
-	}
-
-	/**
-	 * Helper function to send an email.
-	 *
-	 * @param WPInv_Invoice $invoice
-	 * @param GetPaid_Notification_Email $email
-	 * @param string $type
-	 * @param string|array $recipients
-	 * @param array $extra_args Extra template args.
-	 */
-	public function send_email( $invoice, $email, $type, $recipients, $extra_args = array() ) {
-
-		do_action( 'getpaid_before_send_invoice_notification', $type, $invoice, $email );
-
-		$mailer     = new GetPaid_Notification_Email_Sender();
-		$merge_tags = $email->get_merge_tags();
-
-		$result = $mailer->send(
-			apply_filters( 'getpaid_invoice_email_recipients', wpinv_parse_list( $recipients ), $email ),
-			$email->add_merge_tags( $email->get_subject(), $merge_tags ),
-			$email->get_content( $merge_tags, $extra_args ),
-			$email->get_attachments()
-		);
-
-		// Maybe send a copy to the admin.
-		if ( $email->include_admin_bcc() ) {
-			$mailer->send(
-				wpinv_get_admin_email(),
-				$email->add_merge_tags( $email->get_subject() . __( ' - ADMIN BCC COPY', 'invoicing' ), $merge_tags ),
-				$email->get_content( $merge_tags ),
-				$email->get_attachments()
-			);
-		}
-
-		if ( ! $result ) {
-			$invoice->add_note( sprintf( __( 'Failed sending %s notification email.', 'invoicing' ), sanitize_key( $type ) ), false, false, true );
-		}
-
-		do_action( 'getpaid_after_send_invoice_notification', $type, $invoice, $email );
-
-		return $result;
-	}
-
-	/**
-	 * Also send emails to any cc users.
-	 *
-	 * @param array $recipients
-	 * @param GetPaid_Notification_Email $email
-	 */
-	public function filter_email_recipients( $recipients, $email ) {
-
-		if ( ! $email->is_admin_email() ) {
-			$cc = $email->object->get_email_cc();
-
-			if ( ! empty( $cc ) ) {
-				$cc = array_map( 'sanitize_email', wpinv_parse_list( $cc ) );
-				$recipients = array_filter( array_unique( array_merge( $recipients, $cc ) ) );
-			}
-
-		}
-
-		return $recipients;
-
-	}
-
-	/**
-	 * Sends a new invoice notification.
-	 *
-	 * @param WPInv_Invoice $invoice
-	 */
-	public function new_invoice( $invoice ) {
-
-		$email     = new GetPaid_Notification_Email( __FUNCTION__, $invoice );
-		$recipient = wpinv_get_admin_email();
-
-		return $this->send_email( $invoice, $email, __FUNCTION__, $recipient );
-
-	}
-
-	/**
-	 * Sends a cancelled invoice notification.
-	 *
-	 * @param WPInv_Invoice $invoice
-	 */
-	public function cancelled_invoice( $invoice ) {
-
-		$email     = new GetPaid_Notification_Email( __FUNCTION__, $invoice );
-		$recipient = wpinv_get_admin_email();
+    /**
+     * The array of invoice email actions.
+     *
+     * @param array
+     */
+    public $invoice_actions;
+
+    /**
+     * Class constructor
+     *
+     */
+    public function __construct() {
+
+        $this->invoice_actions = apply_filters(
+            'getpaid_notification_email_invoice_triggers',
+            array(
+                'getpaid_new_invoice'                   => array( 'new_invoice', 'user_invoice' ),
+                'getpaid_invoice_status_wpi-cancelled'  => 'cancelled_invoice',
+                'getpaid_invoice_status_wpi-failed'     => 'failed_invoice',
+                'getpaid_invoice_status_wpi-onhold'     => 'onhold_invoice',
+                'getpaid_invoice_status_wpi-processing' => 'processing_invoice',
+                'getpaid_invoice_status_publish'        => 'completed_invoice',
+                'getpaid_invoice_status_wpi-renewal'    => 'completed_invoice',
+                'getpaid_invoice_status_wpi-refunded'   => 'refunded_invoice',
+                'getpaid_new_customer_note'             => 'user_note',
+                'getpaid_daily_maintenance'             => 'overdue',
+            )
+        );
+
+        $this->init_hooks();
+
+    }
+
+    /**
+     * Registers email hooks.
+     */
+    public function init_hooks() {
+
+        add_filter( 'getpaid_get_email_merge_tags', array( $this, 'invoice_merge_tags' ), 10, 2 );
+        add_filter( 'getpaid_invoice_email_recipients', array( $this, 'filter_email_recipients' ), 10, 2 );
+
+        foreach ( $this->invoice_actions as $hook => $email_type ) {
+            $this->init_email_type_hook( $hook, $email_type );
+        }
+    }
+
+    /**
+     * Registers an email hook for an invoice action.
+     * 
+     * @param string $hook
+     * @param string|array $email_type
+     */
+    public function init_email_type_hook( $hook, $email_type ) {
+
+        $email_type = wpinv_parse_list( $email_type );
+
+        foreach ( $email_type as $type ) {
+
+            $email = new GetPaid_Notification_Email( $type );
+
+            // Abort if it is not active.
+            if ( ! $email->is_active() ) {
+                continue;
+            }
+
+            if ( method_exists( $this, $type ) ) {
+                add_action( $hook, array( $this, $type ), 100, 2 );
+                continue;
+            }
+
+            do_action( 'getpaid_invoice_init_email_type_hook', $type );
+        }
+
+    }
+
+    /**
+     * Filters invoice merge tags.
+     *
+     * @param array $merge_tags
+     * @param mixed|WPInv_Invoice|WPInv_Subscription $object
+     */
+    public function invoice_merge_tags( $merge_tags, $object ) {
+
+        if ( is_a( $object, 'WPInv_Invoice' ) ) {
+            return array_merge(
+                $merge_tags,
+                $this->get_invoice_merge_tags( $object )
+            );
+        }
+
+        if ( is_a( $object, 'WPInv_Subscription' ) ) {
+            return array_merge(
+                $merge_tags,
+                $this->get_invoice_merge_tags( $object->get_parent_payment() )
+            );
+        }
+
+        return $merge_tags;
+
+    }
+
+    /**
+     * Generates invoice merge tags.
+     *
+     * @param WPInv_Invoice $invoice
+     * @return array
+     */
+    public function get_invoice_merge_tags( $invoice ) {
+
+        // Abort if it does not exist.
+        if ( ! $invoice->get_id() ) {
+            return array();
+        }
+
+        return array(
+            '{name}'                => sanitize_text_field( $invoice->get_user_full_name() ),
+            '{full_name}'           => sanitize_text_field( $invoice->get_user_full_name() ),
+            '{first_name}'          => sanitize_text_field( $invoice->get_first_name() ),
+            '{last_name}'           => sanitize_text_field( $invoice->get_last_name() ),
+            '{email}'               => sanitize_email( $invoice->get_email() ),
+            '{invoice_number}'      => sanitize_text_field( $invoice->get_number() ),
+            '{invoice_currency}'    => sanitize_text_field( $invoice->get_currency() ),
+            '{invoice_total}'       => wpinv_price( wpinv_format_amount( $invoice->get_total() ) ),
+            '{invoice_link}'        => esc_url( $invoice->get_view_url() ),
+            '{invoice_pay_link}'    => esc_url( $invoice->get_checkout_payment_url() ),
+            '{invoice_receipt_link}'=> esc_url( $invoice->get_receipt_url() ),
+            '{invoice_date}'        => getpaid_format_date_value( $invoice->get_date_created() ),
+            '{invoice_due_date}'    => getpaid_format_date_value( $invoice->get_due_date(), __( 'on receipt', 'invoicing' ) ),
+            '{invoice_quote}'       => sanitize_text_field( $invoice->get_type() ),
+            '{invoice_label}'       => sanitize_text_field( ucfirst( $invoice->get_type() ) ),
+            '{invoice_description}' => wp_kses_post( $invoice->get_description() ),
+            '{subscription_name}'   => wp_kses_post( $invoice->get_subscription_name() ),
+            '{is_was}'              => strtotime( $invoice->get_due_date() ) < current_time( 'timestamp' ) ? __( 'was', 'invoicing' ) : __( 'is', 'invoicing' ),
+        );
+
+    }
+
+    /**
+     * Helper function to send an email.
+     *
+     * @param WPInv_Invoice $invoice
+     * @param GetPaid_Notification_Email $email
+     * @param string $type
+     * @param string|array $recipients
+     * @param array $extra_args Extra template args.
+     */
+    public function send_email( $invoice, $email, $type, $recipients, $extra_args = array() ) {
+
+        do_action( 'getpaid_before_send_invoice_notification', $type, $invoice, $email );
+
+        $mailer     = new GetPaid_Notification_Email_Sender();
+        $merge_tags = $email->get_merge_tags();
+
+        $result = $mailer->send(
+            apply_filters( 'getpaid_invoice_email_recipients', wpinv_parse_list( $recipients ), $email ),
+            $email->add_merge_tags( $email->get_subject(), $merge_tags ),
+            $email->get_content( $merge_tags, $extra_args ),
+            $email->get_attachments()
+        );
+
+        // Maybe send a copy to the admin.
+        if ( $email->include_admin_bcc() ) {
+            $mailer->send(
+                wpinv_get_admin_email(),
+                $email->add_merge_tags( $email->get_subject() . __( ' - ADMIN BCC COPY', 'invoicing' ), $merge_tags ),
+                $email->get_content( $merge_tags ),
+                $email->get_attachments()
+            );
+        }
+
+        if ( ! $result ) {
+            $invoice->add_note( sprintf( __( 'Failed sending %s notification email.', 'invoicing' ), sanitize_key( $type ) ), false, false, true );
+        }
+
+        do_action( 'getpaid_after_send_invoice_notification', $type, $invoice, $email );
+
+        return $result;
+    }
+
+    /**
+     * Also send emails to any cc users.
+     *
+     * @param array $recipients
+     * @param GetPaid_Notification_Email $email
+     */
+    public function filter_email_recipients( $recipients, $email ) {
+
+        if ( ! $email->is_admin_email() ) {
+            $cc = $email->object->get_email_cc();
+
+            if ( ! empty( $cc ) ) {
+                $cc = array_map( 'sanitize_email', wpinv_parse_list( $cc ) );
+                $recipients = array_filter( array_unique( array_merge( $recipients, $cc ) ) );
+            }
+
+        }
+
+        return $recipients;
+
+    }
+
+    /**
+     * Sends a new invoice notification.
+     *
+     * @param WPInv_Invoice $invoice
+     */
+    public function new_invoice( $invoice ) {
+
+        $email     = new GetPaid_Notification_Email( __FUNCTION__, $invoice );
+        $recipient = wpinv_get_admin_email();
+
+        return $this->send_email( $invoice, $email, __FUNCTION__, $recipient );
+
+    }
+
+    /**
+     * Sends a cancelled invoice notification.
+     *
+     * @param WPInv_Invoice $invoice
+     */
+    public function cancelled_invoice( $invoice ) {
+
+        $email     = new GetPaid_Notification_Email( __FUNCTION__, $invoice );
+        $recipient = wpinv_get_admin_email();
 
-		return $this->send_email( $invoice, $email, __FUNCTION__, $recipient );
+        return $this->send_email( $invoice, $email, __FUNCTION__, $recipient );
 
-	}
+    }
 
-	/**
-	 * Sends a failed invoice notification.
-	 *
-	 * @param WPInv_Invoice $invoice
-	 */
-	public function failed_invoice( $invoice ) {
+    /**
+     * Sends a failed invoice notification.
+     *
+     * @param WPInv_Invoice $invoice
+     */
+    public function failed_invoice( $invoice ) {
 
-		$email     = new GetPaid_Notification_Email( __FUNCTION__, $invoice );
-		$recipient = wpinv_get_admin_email();
-
-		return $this->send_email( $invoice, $email, __FUNCTION__, $recipient );
+        $email     = new GetPaid_Notification_Email( __FUNCTION__, $invoice );
+        $recipient = wpinv_get_admin_email();
+
+        return $this->send_email( $invoice, $email, __FUNCTION__, $recipient );
 
-	}
+    }
 
-	/**
-	 * Sends a notification whenever an invoice is put on hold.
-	 *
-	 * @param WPInv_Invoice $invoice
-	 */
-	public function onhold_invoice( $invoice ) {
+    /**
+     * Sends a notification whenever an invoice is put on hold.
+     *
+     * @param WPInv_Invoice $invoice
+     */
+    public function onhold_invoice( $invoice ) {
 
-		$email     = new GetPaid_Notification_Email( __FUNCTION__, $invoice );
-		$recipient = $invoice->get_email();
+        $email     = new GetPaid_Notification_Email( __FUNCTION__, $invoice );
+        $recipient = $invoice->get_email();
 
-		return $this->send_email( $invoice, $email, __FUNCTION__, $recipient );
+        return $this->send_email( $invoice, $email, __FUNCTION__, $recipient );
 
-	}
+    }
 
-	/**
-	 * Sends a notification whenever an invoice is marked as processing payment.
-	 *
-	 * @param WPInv_Invoice $invoice
-	 */
-	public function processing_invoice( $invoice ) {
+    /**
+     * Sends a notification whenever an invoice is marked as processing payment.
+     *
+     * @param WPInv_Invoice $invoice
+     */
+    public function processing_invoice( $invoice ) {
 
-		$email     = new GetPaid_Notification_Email( __FUNCTION__, $invoice );
-		$recipient = $invoice->get_email();
+        $email     = new GetPaid_Notification_Email( __FUNCTION__, $invoice );
+        $recipient = $invoice->get_email();
 
-		return $this->send_email( $invoice, $email, __FUNCTION__, $recipient );
+        return $this->send_email( $invoice, $email, __FUNCTION__, $recipient );
 
-	}
+    }
 
-	/**
-	 * Sends a notification whenever an invoice is paid.
-	 *
-	 * @param WPInv_Invoice $invoice
-	 */
-	public function completed_invoice( $invoice ) {
+    /**
+     * Sends a notification whenever an invoice is paid.
+     *
+     * @param WPInv_Invoice $invoice
+     */
+    public function completed_invoice( $invoice ) {
 
-		// (Maybe) abort if it is a renewal invoice.
-		if ( $invoice->is_renewal() && ! wpinv_get_option( 'email_completed_invoice_renewal_active', false ) ) {
-			return;
-		}
+        // (Maybe) abort if it is a renewal invoice.
+        if ( $invoice->is_renewal() && ! wpinv_get_option( 'email_completed_invoice_renewal_active', false ) ) {
+            return;
+        }
 
-		$email     = new GetPaid_Notification_Email( __FUNCTION__, $invoice );
-		$recipient = $invoice->get_email();
+        $email     = new GetPaid_Notification_Email( __FUNCTION__, $invoice );
+        $recipient = $invoice->get_email();
 
-		return $this->send_email( $invoice, $email, __FUNCTION__, $recipient );
+        return $this->send_email( $invoice, $email, __FUNCTION__, $recipient );
 
-	}
+    }
 
-	/**
-	 * Sends a notification whenever an invoice is refunded.
-	 *
-	 * @param WPInv_Invoice $invoice
-	 */
-	public function refunded_invoice( $invoice ) {
+    /**
+     * Sends a notification whenever an invoice is refunded.
+     *
+     * @param WPInv_Invoice $invoice
+     */
+    public function refunded_invoice( $invoice ) {
 
-		$email     = new GetPaid_Notification_Email( __FUNCTION__, $invoice );
-		$recipient = $invoice->get_email();
+        $email     = new GetPaid_Notification_Email( __FUNCTION__, $invoice );
+        $recipient = $invoice->get_email();
 
-		return $this->send_email( $invoice, $email, __FUNCTION__, $recipient );
+        return $this->send_email( $invoice, $email, __FUNCTION__, $recipient );
 
-	}
+    }
 
-	/**
-	 * Notifies a user about new invoices
-	 *
-	 * @param WPInv_Invoice $invoice
-	 */
-	public function user_invoice( $invoice ) {
+    /**
+     * Notifies a user about new invoices
+     *
+     * @param WPInv_Invoice $invoice
+     */
+    public function user_invoice( $invoice ) {
 
-		// Only send this email for invoices created via the admin page.
-		if ( $this->is_payment_form_invoice( $invoice->get_id() ) ) {
-			return;
-		}
+        // Only send this email for invoices created via the admin page.
+        if ( $this->is_payment_form_invoice( $invoice->get_id() ) ) {
+            return;
+        }
 
-		$email     = new GetPaid_Notification_Email( __FUNCTION__, $invoice );
-		$recipient = $invoice->get_email();
+        $email     = new GetPaid_Notification_Email( __FUNCTION__, $invoice );
+        $recipient = $invoice->get_email();
 
-		return $this->send_email( $invoice, $email, __FUNCTION__, $recipient );
+        return $this->send_email( $invoice, $email, __FUNCTION__, $recipient );
 
-	}
+    }
 
-	/**
-	 * Checks if an invoice is a payment form invoice.
-	 *
-	 * @param int $invoice
-	 * @return bool
-	 */
-	public function is_payment_form_invoice( $invoice ) {
-		return empty( $_GET['getpaid-admin-action'] ) && 'payment_form' == get_post_meta( $invoice, 'wpinv_created_via', true );
-	}
+    /**
+     * Checks if an invoice is a payment form invoice.
+     *
+     * @param int $invoice
+     * @return bool
+     */
+    public function is_payment_form_invoice( $invoice ) {
+        return empty( $_GET['getpaid-admin-action'] ) && 'payment_form' == get_post_meta( $invoice, 'wpinv_created_via', true );
+    }
 
-	/**
-	 * Notifies admin about new invoice notes
-	 *
-	 * @param WPInv_Invoice $invoice
-	 * @param string $note
-	 */
-	public function user_note( $invoice, $note ) {
+    /**
+     * Notifies admin about new invoice notes
+     *
+     * @param WPInv_Invoice $invoice
+     * @param string $note
+     */
+    public function user_note( $invoice, $note ) {
 
-		$email     = new GetPaid_Notification_Email( __FUNCTION__, $invoice );
-		$recipient = $invoice->get_email();
-
-		return $this->send_email( $invoice, $email, __FUNCTION__, $recipient, array( 'customer_note' => $note ) );
-
-	}
+        $email     = new GetPaid_Notification_Email( __FUNCTION__, $invoice );
+        $recipient = $invoice->get_email();
+
+        return $this->send_email( $invoice, $email, __FUNCTION__, $recipient, array( 'customer_note' => $note ) );
+
+    }
 
-	/**
-	 * (Force) Sends overdue notices.
-	 *
-	 * @param WPInv_Invoice $invoice
-	 */
-	public function force_send_overdue_notice( $invoice ) {
-		$email = new GetPaid_Notification_Email( 'overdue', $invoice );
-		return $this->send_email( $invoice, $email, 'overdue', $invoice->get_email() );
-	}
-
-	/**
-	 * Sends overdue notices.
-	 *
-	 * @TODO: Create an invoices query class.
-	 */
-	public function overdue() {
-		global $wpdb;
-
-		$email = new GetPaid_Notification_Email( __FUNCTION__ );
-
-		// Fetch reminder days.
-		$reminder_days = array_unique( wp_parse_id_list( $email->get_option( 'days' ) ) );
-
-		// Abort if non is set.
-		if ( empty( $reminder_days ) ) {
-			return;
-		}
-
-		// Retrieve date query.
-		$date_query = $this->get_date_query( $reminder_days );
-
-		// Invoices table.
-		$table = $wpdb->prefix . 'getpaid_invoices';
-
-		// Fetch invoices.
-		$invoices  = $wpdb->get_col(
-			"SELECT posts.ID FROM $wpdb->posts as posts
+    /**
+     * (Force) Sends overdue notices.
+     *
+     * @param WPInv_Invoice $invoice
+     */
+    public function force_send_overdue_notice( $invoice ) {
+        $email = new GetPaid_Notification_Email( 'overdue', $invoice );
+        return $this->send_email( $invoice, $email, 'overdue', $invoice->get_email() );
+    }
+
+    /**
+     * Sends overdue notices.
+     *
+     * @TODO: Create an invoices query class.
+     */
+    public function overdue() {
+        global $wpdb;
+
+        $email = new GetPaid_Notification_Email( __FUNCTION__ );
+
+        // Fetch reminder days.
+        $reminder_days = array_unique( wp_parse_id_list( $email->get_option( 'days' ) ) );
+
+        // Abort if non is set.
+        if ( empty( $reminder_days ) ) {
+            return;
+        }
+
+        // Retrieve date query.
+        $date_query = $this->get_date_query( $reminder_days );
+
+        // Invoices table.
+        $table = $wpdb->prefix . 'getpaid_invoices';
+
+        // Fetch invoices.
+        $invoices  = $wpdb->get_col(
+            "SELECT posts.ID FROM $wpdb->posts as posts
 			LEFT JOIN $table as invoices ON invoices.post_id = posts.ID
 			WHERE posts.post_type = 'wpi_invoice' AND posts.post_status = 'wpi-pending' $date_query");
 
-		foreach ( $invoices as $invoice ) {
+        foreach ( $invoices as $invoice ) {
 
-			// Only send this email for invoices created via the admin page.
-			if ( ! $this->is_payment_form_invoice( $invoice ) ) {
-				$invoice       = new WPInv_Invoice( $invoice );
-				$email->object = $invoice;
+            // Only send this email for invoices created via the admin page.
+            if ( ! $this->is_payment_form_invoice( $invoice ) ) {
+                $invoice       = new WPInv_Invoice( $invoice );
+                $email->object = $invoice;
 
-				if ( $invoice->needs_payment() ) {
-					$this->send_email( $invoice, $email, __FUNCTION__, $invoice->get_email() );
-				}
+                if ( $invoice->needs_payment() ) {
+                    $this->send_email( $invoice, $email, __FUNCTION__, $invoice->get_email() );
+                }
 
-			}
+            }
 
-		}
+        }
 
-	}
+    }
 
-	/**
-	 * Calculates the date query for an invoices query
-	 *
-	 * @param array $reminder_days
-	 * @return string
-	 */
-	public function get_date_query( $reminder_days ) {
+    /**
+     * Calculates the date query for an invoices query
+     *
+     * @param array $reminder_days
+     * @return string
+     */
+    public function get_date_query( $reminder_days ) {
 
-		$date_query = array(
-			'relation'  => 'OR'
-		);
+        $date_query = array(
+            'relation'  => 'OR'
+        );
 
-		foreach ( $reminder_days as $days ) {
-			$date = date_parse( date( 'Y-m-d', strtotime( "-$days days", current_time( 'timestamp' ) ) ) );
+        foreach ( $reminder_days as $days ) {
+            $date = date_parse( date( 'Y-m-d', strtotime( "-$days days", current_time( 'timestamp' ) ) ) );
 
-			$date_query[] = array(
-				'year'  => $date['year'],
-				'month' => $date['month'],
-				'day'   => $date['day'],
-			);
+            $date_query[] = array(
+                'year'  => $date['year'],
+                'month' => $date['month'],
+                'day'   => $date['day'],
+            );
 
-		}
+        }
 
-		$date_query = new WP_Date_Query( $date_query, 'invoices.due_date' );
+        $date_query = new WP_Date_Query( $date_query, 'invoices.due_date' );
 
-		return $date_query->get_sql();
+        return $date_query->get_sql();
 
-	}
+    }
 
 }

includes/gateways/class-getpaid-manual-gateway.php

Indentation +31 added lines, -31 removed lines

@@ -13,30 +13,30 @@ 
 class GetPaid_Manual_Gateway extends GetPaid_Payment_Gateway {
 
     /**
-	 * Payment method id.
-	 *
-	 * @var string
-	 */
+     * Payment method id.
+     *
+     * @var string
+     */
     public $id = 'manual';
 
     /**
-	 * An array of features that this gateway supports.
-	 *
-	 * @var array
-	 */
+     * An array of features that this gateway supports.
+     *
+     * @var array
+     */
     protected $supports = array( 'subscription' );
 
     /**
-	 * Payment method order.
-	 *
-	 * @var int
-	 */
-	public $order = 11;
+     * Payment method order.
+     *
+     * @var int
+     */
+    public $order = 11;
     
     /**
-	 * Class constructor.
-	 */
-	public function __construct() {
+     * Class constructor.
+     */
+    public function __construct() {
         parent::__construct();
 
         $this->title        = __( 'Manual Payment', 'invoicing' );
@@ -46,15 +46,15 @@ 
     }
 
     /**
-	 * Process Payment.
-	 *
-	 *
-	 * @param WPInv_Invoice $invoice Invoice.
-	 * @param array $submission_data Posted checkout fields.
-	 * @param GetPaid_Payment_Form_Submission $submission Checkout submission.
-	 * @return array
-	 */
-	public function process_payment( $invoice, $submission_data, $submission ) {
+     * Process Payment.
+     *
+     *
+     * @param WPInv_Invoice $invoice Invoice.
+     * @param array $submission_data Posted checkout fields.
+     * @param GetPaid_Payment_Form_Submission $submission Checkout submission.
+     * @return array
+     */
+    public function process_payment( $invoice, $submission_data, $submission ) {
 
         // Mark it as paid.
         $invoice->mark_paid();
@@ -68,13 +68,13 @@ 
     }
 
     /**
-	 * (Maybe) renews a manual subscription profile.
-	 *
-	 *
-	 * @param bool $should_expire
+     * (Maybe) renews a manual subscription profile.
+     *
+     *
+     * @param bool $should_expire
      * @param WPInv_Subscription $subscription
-	 */
-	public function maybe_renew_subscription( $should_expire, $subscription ) {
+     */
+    public function maybe_renew_subscription( $should_expire, $subscription ) {
 
         // Ensure its our subscription && it's active.
         if ( 'manual' != $subscription->get_gateway() || ! $subscription->has_status( 'active trialling' ) ) {