AyeCode / invoicing

includes/data-stores/class-getpaid-invoice-data-store.php

Indentation +475 added lines, -475 removed lines

@@ -5,7 +5,7 @@ 
  *
  */
 if ( ! defined( 'ABSPATH' ) ) {
-	exit;
+    exit;
 }
 
 /**
@@ -15,540 +15,540 @@ 
  */
 class GetPaid_Invoice_Data_Store extends GetPaid_Data_Store_WP {
 
-	/**
-	 * Data stored in meta keys, but not considered "meta" for a discount.
-	 *
-	 * @since 1.0.19
-	 * @var array
-	 */
-	protected $internal_meta_keys = array(
-		'_wpinv_subscr_profile_id',
-		'_wpinv_subscription_id',
-		'_wpinv_taxes',
-		'_wpinv_fees',
-		'_wpinv_discounts',
-		'_wpinv_submission_id',
-		'_wpinv_payment_form',
-		'_wpinv_is_viewed',
-		'_wpinv_phone',
-		'wpinv_email_cc',
-		'wpinv_template',
-		'wpinv_created_via'
-	);
-
-	/**
-	 * A map of meta keys to data props.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @var array
-	 */
-	protected $meta_key_to_props = array(
-		'_wpinv_subscr_profile_id' => 'remote_subscription_id',
-		'_wpinv_subscription_id'   => 'subscription_id',
-		'_wpinv_taxes'             => 'taxes',
-		'_wpinv_fees'              => 'fees',
-		'_wpinv_discounts'         => 'discounts',
-		'_wpinv_submission_id'     => 'submission_id',
-		'_wpinv_payment_form'      => 'payment_form',
-		'_wpinv_is_viewed'         => 'is_viewed',
-		'wpinv_email_cc'           => 'email_cc',
-		'wpinv_template'           => 'template',
-		'wpinv_created_via'        => 'created_via',
-		'_wpinv_phone'             => 'phone',
-	);
-
-	/**
-	 * A map of database fields to data props.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @var array
-	 */
-	protected $database_fields_to_props = array(
-		'post_id'            => 'id',
-		'number'             => 'number',
-		'currency'           => 'currency',
-		'key'                => 'key',
-		'type'               => 'type',
-		'mode'               => 'mode',
-		'user_ip'            => 'user_ip',
-		'first_name'         => 'first_name',
-		'last_name'          => 'last_name',
-		'address'            => 'address',
-		'city'               => 'city',
-		'state'              => 'state',
-		'country'            => 'country',
-		'zip'                => 'zip',
-		'zip'                => 'zip',
-		'adddress_confirmed' => 'address_confirmed',
-		'gateway'            => 'gateway',
-		'transaction_id'     => 'transaction_id',
-		'currency'           => 'currency',
-		'subtotal'           => 'subtotal',
-		'tax'                => 'total_tax',
-		'fees_total'         => 'total_fees',
-		'discount'           => 'total_discount',
-		'total'              => 'total',
-		'discount_code'      => 'discount_code',
-		'disable_taxes'      => 'disable_taxes',
-		'due_date'           => 'due_date',
-		'completed_date'     => 'completed_date',
-		'company'            => 'company',
-		'vat_number'         => 'vat_number',
-		'vat_rate'           => 'vat_rate',
-	);
-
-	/*
+    /**
+     * Data stored in meta keys, but not considered "meta" for a discount.
+     *
+     * @since 1.0.19
+     * @var array
+     */
+    protected $internal_meta_keys = array(
+        '_wpinv_subscr_profile_id',
+        '_wpinv_subscription_id',
+        '_wpinv_taxes',
+        '_wpinv_fees',
+        '_wpinv_discounts',
+        '_wpinv_submission_id',
+        '_wpinv_payment_form',
+        '_wpinv_is_viewed',
+        '_wpinv_phone',
+        'wpinv_email_cc',
+        'wpinv_template',
+        'wpinv_created_via'
+    );
+
+    /**
+     * A map of meta keys to data props.
+     *
+     * @since 1.0.19
+     *
+     * @var array
+     */
+    protected $meta_key_to_props = array(
+        '_wpinv_subscr_profile_id' => 'remote_subscription_id',
+        '_wpinv_subscription_id'   => 'subscription_id',
+        '_wpinv_taxes'             => 'taxes',
+        '_wpinv_fees'              => 'fees',
+        '_wpinv_discounts'         => 'discounts',
+        '_wpinv_submission_id'     => 'submission_id',
+        '_wpinv_payment_form'      => 'payment_form',
+        '_wpinv_is_viewed'         => 'is_viewed',
+        'wpinv_email_cc'           => 'email_cc',
+        'wpinv_template'           => 'template',
+        'wpinv_created_via'        => 'created_via',
+        '_wpinv_phone'             => 'phone',
+    );
+
+    /**
+     * A map of database fields to data props.
+     *
+     * @since 1.0.19
+     *
+     * @var array
+     */
+    protected $database_fields_to_props = array(
+        'post_id'            => 'id',
+        'number'             => 'number',
+        'currency'           => 'currency',
+        'key'                => 'key',
+        'type'               => 'type',
+        'mode'               => 'mode',
+        'user_ip'            => 'user_ip',
+        'first_name'         => 'first_name',
+        'last_name'          => 'last_name',
+        'address'            => 'address',
+        'city'               => 'city',
+        'state'              => 'state',
+        'country'            => 'country',
+        'zip'                => 'zip',
+        'zip'                => 'zip',
+        'adddress_confirmed' => 'address_confirmed',
+        'gateway'            => 'gateway',
+        'transaction_id'     => 'transaction_id',
+        'currency'           => 'currency',
+        'subtotal'           => 'subtotal',
+        'tax'                => 'total_tax',
+        'fees_total'         => 'total_fees',
+        'discount'           => 'total_discount',
+        'total'              => 'total',
+        'discount_code'      => 'discount_code',
+        'disable_taxes'      => 'disable_taxes',
+        'due_date'           => 'due_date',
+        'completed_date'     => 'completed_date',
+        'company'            => 'company',
+        'vat_number'         => 'vat_number',
+        'vat_rate'           => 'vat_rate',
+    );
+
+    /*
 	|--------------------------------------------------------------------------
 	| CRUD Methods
 	|--------------------------------------------------------------------------
 	*/
 
-	/**
-	 * Method to create a new invoice in the database.
-	 *
-	 * @param WPInv_Invoice $invoice Invoice object.
-	 */
-	public function create( &$invoice ) {
-		$invoice->set_version( WPINV_VERSION );
-		$invoice->set_date_created( current_time('mysql') );
-
-		// Create a new post.
-		$id = wp_insert_post(
-			apply_filters(
-				'getpaid_new_invoice_data',
-				array(
-					'post_date'     => $invoice->get_date_created( 'edit' ),
-					'post_type'     => $invoice->get_post_type( 'edit' ),
-					'post_status'   => $this->get_post_status( $invoice ),
-					'ping_status'   => 'closed',
-					'post_author'   => $invoice->get_user_id( 'edit' ),
-					'post_title'    => $invoice->get_title( 'edit' ),
-					'post_excerpt'  => $invoice->get_description( 'edit' ),
-					'post_parent'   => $invoice->get_parent_id( 'edit' ),
-				)
-			),
-			true
-		);
-
-		if ( $id && ! is_wp_error( $id ) ) {
-
-			// Update the new id and regenerate a title.
-			$invoice->set_id( $id );
-
-			$invoice->maybe_set_number();
-
-			wp_update_post(
-				array(
-					'ID'         => $invoice->get_id(),
-					'post_title' => $invoice->get_number( 'edit' ),
-					'post_name'  => $invoice->get_path( 'edit' )
-				)
-			);
-
-			// Save special fields and items.
-			$this->save_special_fields( $invoice );
-			$this->save_items( $invoice );
-
-			// Update meta data.
-			$this->update_post_meta( $invoice );
-			$invoice->save_meta_data();
-
-			// Apply changes.
-			$invoice->apply_changes();
-			$this->clear_caches( $invoice );
-
-			// Fires after a new invoice is created.
-			do_action( 'getpaid_new_invoice', $invoice );
-			return true;
-		}
-
-		if ( is_wp_error( $id ) ) {
-			$invoice->last_error = $id->get_error_message();
-		}
-
-		return false;
-	}
-
-	/**
-	 * Method to read an invoice from the database.
-	 *
-	 * @param WPInv_Invoice $invoice Invoice object.
-	 *
-	 */
-	public function read( &$invoice ) {
-
-		$invoice->set_defaults();
-		$invoice_object = get_post( $invoice->get_id() );
-
-		if ( ! $invoice->get_id() || ! $invoice_object || ! getpaid_is_invoice_post_type( $invoice_object->post_type ) ) {
-			$invoice->last_error = __( 'Invalid invoice.', 'invoicing' );
-			$invoice->set_id( 0 );
-			return false;
-		}
-
-		$invoice->set_props(
-			array(
-				'date_created'  => 0 < $invoice_object->post_date ? $invoice_object->post_date : null,
-				'date_modified' => 0 < $invoice_object->post_modified ? $invoice_object->post_modified : null,
-				'status'        => $invoice_object->post_status,
-				'author'        => $invoice_object->post_author,
-				'description'   => $invoice_object->post_excerpt,
-				'parent_id'     => $invoice_object->post_parent,
-				'name'          => $invoice_object->post_title,
-				'path'          => $invoice_object->post_name,
-				'post_type'     => $invoice_object->post_type,
-			)
-		);
-
-		$invoice->set_type( $invoice_object->post_type );
-
-		$this->read_object_data( $invoice, $invoice_object );
-		$this->add_special_fields( $invoice );
-		$this->add_items( $invoice );
-		$invoice->read_meta_data();
-		$invoice->set_object_read( true );
-		do_action( 'getpaid_read_invoice', $invoice );
-
-	}
-
-	/**
-	 * Method to update an invoice in the database.
-	 *
-	 * @param WPInv_Invoice $invoice Invoice object.
-	 */
-	public function update( &$invoice ) {
-		$invoice->save_meta_data();
-		$invoice->set_version( WPINV_VERSION );
-
-		if ( null === $invoice->get_date_created( 'edit' ) ) {
-			$invoice->set_date_created(  current_time('mysql') );
-		}
-
-		// Ensure both the key and number are set.
-		$invoice->get_path();
-
-		// Grab the current status so we can compare.
-		$previous_status = get_post_status( $invoice->get_id() );
-
-		$changes = $invoice->get_changes();
-
-		// Only update the post when the post data changes.
-		if ( array_intersect( array( 'date_created', 'date_modified', 'status', 'name', 'author', 'description', 'parent_id', 'post_excerpt', 'path' ), array_keys( $changes ) ) ) {
-			$post_data = array(
-				'post_date'         => $invoice->get_date_created( 'edit' ),
-				'post_date_gmt'     => $invoice->get_date_created_gmt( 'edit' ),
-				'post_status'       => $invoice->get_status( 'edit' ),
-				'post_title'        => $invoice->get_name( 'edit' ),
-				'post_author'       => $invoice->get_user_id( 'edit' ),
-				'post_modified'     => $invoice->get_date_modified( 'edit' ),
-				'post_excerpt'      => $invoice->get_description( 'edit' ),
-				'post_parent'       => $invoice->get_parent_id( 'edit' ),
-				'post_name'         => $invoice->get_path( 'edit' ),
-				'post_type'         => $invoice->get_post_type( 'edit' ),
-			);
-
-			/**
-			 * When updating this object, to prevent infinite loops, use $wpdb
-			 * to update data, since wp_update_post spawns more calls to the
-			 * save_post action.
-			 *
-			 * This ensures hooks are fired by either WP itself (admin screen save),
-			 * or an update purely from CRUD.
-			 */
-			if ( doing_action( 'save_post' ) ) {
-				$GLOBALS['wpdb']->update( $GLOBALS['wpdb']->posts, $post_data, array( 'ID' => $invoice->get_id() ) );
-				clean_post_cache( $invoice->get_id() );
-			} else {
-				wp_update_post( array_merge( array( 'ID' => $invoice->get_id() ), $post_data ) );
-			}
-			$invoice->read_meta_data( true ); // Refresh internal meta data, in case things were hooked into `save_post` or another WP hook.
-		}
-
-		// Update meta data.
-		$this->update_post_meta( $invoice );
-
-		// Save special fields and items.
-		$this->save_special_fields( $invoice );
-		$this->save_items( $invoice );
-
-		// Apply the changes.
-		$invoice->apply_changes();
-
-		// Clear caches.
-		$this->clear_caches( $invoice );
-
-		// Fire a hook depending on the status - this should be considered a creation if it was previously draft status.
-		$new_status = $invoice->get_status( 'edit' );
-
-		if ( $new_status !== $previous_status && in_array( $previous_status, array( 'new', 'auto-draft', 'draft' ), true ) ) {
-			do_action( 'getpaid_new_invoice', $invoice );
-		} else {
-			do_action( 'getpaid_update_invoice', $invoice );
-		}
-
-	}
-
-	/*
+    /**
+     * Method to create a new invoice in the database.
+     *
+     * @param WPInv_Invoice $invoice Invoice object.
+     */
+    public function create( &$invoice ) {
+        $invoice->set_version( WPINV_VERSION );
+        $invoice->set_date_created( current_time('mysql') );
+
+        // Create a new post.
+        $id = wp_insert_post(
+            apply_filters(
+                'getpaid_new_invoice_data',
+                array(
+                    'post_date'     => $invoice->get_date_created( 'edit' ),
+                    'post_type'     => $invoice->get_post_type( 'edit' ),
+                    'post_status'   => $this->get_post_status( $invoice ),
+                    'ping_status'   => 'closed',
+                    'post_author'   => $invoice->get_user_id( 'edit' ),
+                    'post_title'    => $invoice->get_title( 'edit' ),
+                    'post_excerpt'  => $invoice->get_description( 'edit' ),
+                    'post_parent'   => $invoice->get_parent_id( 'edit' ),
+                )
+            ),
+            true
+        );
+
+        if ( $id && ! is_wp_error( $id ) ) {
+
+            // Update the new id and regenerate a title.
+            $invoice->set_id( $id );
+
+            $invoice->maybe_set_number();
+
+            wp_update_post(
+                array(
+                    'ID'         => $invoice->get_id(),
+                    'post_title' => $invoice->get_number( 'edit' ),
+                    'post_name'  => $invoice->get_path( 'edit' )
+                )
+            );
+
+            // Save special fields and items.
+            $this->save_special_fields( $invoice );
+            $this->save_items( $invoice );
+
+            // Update meta data.
+            $this->update_post_meta( $invoice );
+            $invoice->save_meta_data();
+
+            // Apply changes.
+            $invoice->apply_changes();
+            $this->clear_caches( $invoice );
+
+            // Fires after a new invoice is created.
+            do_action( 'getpaid_new_invoice', $invoice );
+            return true;
+        }
+
+        if ( is_wp_error( $id ) ) {
+            $invoice->last_error = $id->get_error_message();
+        }
+
+        return false;
+    }
+
+    /**
+     * Method to read an invoice from the database.
+     *
+     * @param WPInv_Invoice $invoice Invoice object.
+     *
+     */
+    public function read( &$invoice ) {
+
+        $invoice->set_defaults();
+        $invoice_object = get_post( $invoice->get_id() );
+
+        if ( ! $invoice->get_id() || ! $invoice_object || ! getpaid_is_invoice_post_type( $invoice_object->post_type ) ) {
+            $invoice->last_error = __( 'Invalid invoice.', 'invoicing' );
+            $invoice->set_id( 0 );
+            return false;
+        }
+
+        $invoice->set_props(
+            array(
+                'date_created'  => 0 < $invoice_object->post_date ? $invoice_object->post_date : null,
+                'date_modified' => 0 < $invoice_object->post_modified ? $invoice_object->post_modified : null,
+                'status'        => $invoice_object->post_status,
+                'author'        => $invoice_object->post_author,
+                'description'   => $invoice_object->post_excerpt,
+                'parent_id'     => $invoice_object->post_parent,
+                'name'          => $invoice_object->post_title,
+                'path'          => $invoice_object->post_name,
+                'post_type'     => $invoice_object->post_type,
+            )
+        );
+
+        $invoice->set_type( $invoice_object->post_type );
+
+        $this->read_object_data( $invoice, $invoice_object );
+        $this->add_special_fields( $invoice );
+        $this->add_items( $invoice );
+        $invoice->read_meta_data();
+        $invoice->set_object_read( true );
+        do_action( 'getpaid_read_invoice', $invoice );
+
+    }
+
+    /**
+     * Method to update an invoice in the database.
+     *
+     * @param WPInv_Invoice $invoice Invoice object.
+     */
+    public function update( &$invoice ) {
+        $invoice->save_meta_data();
+        $invoice->set_version( WPINV_VERSION );
+
+        if ( null === $invoice->get_date_created( 'edit' ) ) {
+            $invoice->set_date_created(  current_time('mysql') );
+        }
+
+        // Ensure both the key and number are set.
+        $invoice->get_path();
+
+        // Grab the current status so we can compare.
+        $previous_status = get_post_status( $invoice->get_id() );
+
+        $changes = $invoice->get_changes();
+
+        // Only update the post when the post data changes.
+        if ( array_intersect( array( 'date_created', 'date_modified', 'status', 'name', 'author', 'description', 'parent_id', 'post_excerpt', 'path' ), array_keys( $changes ) ) ) {
+            $post_data = array(
+                'post_date'         => $invoice->get_date_created( 'edit' ),
+                'post_date_gmt'     => $invoice->get_date_created_gmt( 'edit' ),
+                'post_status'       => $invoice->get_status( 'edit' ),
+                'post_title'        => $invoice->get_name( 'edit' ),
+                'post_author'       => $invoice->get_user_id( 'edit' ),
+                'post_modified'     => $invoice->get_date_modified( 'edit' ),
+                'post_excerpt'      => $invoice->get_description( 'edit' ),
+                'post_parent'       => $invoice->get_parent_id( 'edit' ),
+                'post_name'         => $invoice->get_path( 'edit' ),
+                'post_type'         => $invoice->get_post_type( 'edit' ),
+            );
+
+            /**
+             * When updating this object, to prevent infinite loops, use $wpdb
+             * to update data, since wp_update_post spawns more calls to the
+             * save_post action.
+             *
+             * This ensures hooks are fired by either WP itself (admin screen save),
+             * or an update purely from CRUD.
+             */
+            if ( doing_action( 'save_post' ) ) {
+                $GLOBALS['wpdb']->update( $GLOBALS['wpdb']->posts, $post_data, array( 'ID' => $invoice->get_id() ) );
+                clean_post_cache( $invoice->get_id() );
+            } else {
+                wp_update_post( array_merge( array( 'ID' => $invoice->get_id() ), $post_data ) );
+            }
+            $invoice->read_meta_data( true ); // Refresh internal meta data, in case things were hooked into `save_post` or another WP hook.
+        }
+
+        // Update meta data.
+        $this->update_post_meta( $invoice );
+
+        // Save special fields and items.
+        $this->save_special_fields( $invoice );
+        $this->save_items( $invoice );
+
+        // Apply the changes.
+        $invoice->apply_changes();
+
+        // Clear caches.
+        $this->clear_caches( $invoice );
+
+        // Fire a hook depending on the status - this should be considered a creation if it was previously draft status.
+        $new_status = $invoice->get_status( 'edit' );
+
+        if ( $new_status !== $previous_status && in_array( $previous_status, array( 'new', 'auto-draft', 'draft' ), true ) ) {
+            do_action( 'getpaid_new_invoice', $invoice );
+        } else {
+            do_action( 'getpaid_update_invoice', $invoice );
+        }
+
+    }
+
+    /*
 	|--------------------------------------------------------------------------
 	| Additional Methods
 	|--------------------------------------------------------------------------
 	*/
 
-	/**
+    /**
      * Retrieves special fields and adds to the invoice.
-	 *
-	 * @param WPInv_Invoice $invoice Invoice object.
+     *
+     * @param WPInv_Invoice $invoice Invoice object.
      */
     public function add_special_fields( &$invoice ) {
-		global $wpdb;
+        global $wpdb;
 
-		// Maybe retrieve from the cache.
-		$data   = wp_cache_get( $invoice->get_id(), 'getpaid_invoice_special_fields' );
+        // Maybe retrieve from the cache.
+        $data   = wp_cache_get( $invoice->get_id(), 'getpaid_invoice_special_fields' );
 
-		// If not found, retrieve from the db.
-		if ( false === $data ) {
-			$table =  $wpdb->prefix . 'getpaid_invoices';
+        // If not found, retrieve from the db.
+        if ( false === $data ) {
+            $table =  $wpdb->prefix . 'getpaid_invoices';
 
-			$data  = $wpdb->get_row(
-				$wpdb->prepare( "SELECT * FROM $table WHERE `post_id`=%d LIMIT 1", $invoice->get_id() ),
-				ARRAY_A
-			);
+            $data  = $wpdb->get_row(
+                $wpdb->prepare( "SELECT * FROM $table WHERE `post_id`=%d LIMIT 1", $invoice->get_id() ),
+                ARRAY_A
+            );
 
-			// Update the cache with our data
-			wp_cache_set( $invoice->get_id(), $data, 'getpaid_invoice_special_fields' );
+            // Update the cache with our data
+            wp_cache_set( $invoice->get_id(), $data, 'getpaid_invoice_special_fields' );
 
-		}
+        }
 
-		// Abort if the data does not exist.
-		if ( empty( $data ) ) {
-			$invoice->set_object_read( true );
-			$invoice->set_props( wpinv_get_user_address( $invoice->get_user_id() ) );
-			return;
-		}
+        // Abort if the data does not exist.
+        if ( empty( $data ) ) {
+            $invoice->set_object_read( true );
+            $invoice->set_props( wpinv_get_user_address( $invoice->get_user_id() ) );
+            return;
+        }
 
-		$props = array();
+        $props = array();
 
-		foreach ( $this->database_fields_to_props as $db_field => $prop ) {
+        foreach ( $this->database_fields_to_props as $db_field => $prop ) {
 			
-			if ( $db_field == 'post_id' ) {
-				continue;
-			}
-
-			$props[ $prop ] = $data[ $db_field ];
-		}
-
-		$invoice->set_props( $props );
-
-	}
-
-	/**
-	 * Gets a list of special fields that need updated based on change state
-	 * or if they are present in the database or not.
-	 *
-	 * @param  WPInv_Invoice $invoice       The Invoice object.
-	 * @return array                        A mapping of field keys => prop names, filtered by ones that should be updated.
-	 */
-	protected function get_special_fields_to_update( $invoice ) {
-		$fields_to_update = array();
-		$changed_props   = $invoice->get_changes();
-
-		// Props should be updated if they are a part of the $changed array or don't exist yet.
-		foreach ( $this->database_fields_to_props as $database_field => $prop ) {
-			if ( array_key_exists( $prop, $changed_props ) ) {
-				$fields_to_update[ $database_field ] = $prop;
-			}
-		}
-
-		return $fields_to_update;
-	}
-
-	/**
-	 * Helper method that updates all the database fields for an invoice based on it's settings in the WPInv_Invoice class.
-	 *
-	 * @param WPInv_Invoice $invoice WPInv_Invoice object.
-	 * @since 1.0.19
-	 */
-	protected function update_special_fields( &$invoice ) {
-		global $wpdb;
-
-		$updated_props    = array();
-		$fields_to_update = $this->get_special_fields_to_update( $invoice );
-
-		foreach ( $fields_to_update as $database_field => $prop ) {
-			$value = $invoice->{"get_$prop"}( 'edit' );
-			$value = is_string( $value ) ? wp_slash( $value ) : $value;
-			$value = is_bool( $value ) ? ( int ) $value : $value;
-			$updated_props[ $database_field ] = maybe_serialize( $value );
-		}
-
-		if ( ! empty( $updated_props ) ) {
-
-			$table = $wpdb->prefix . 'getpaid_invoices';
-			$wpdb->update( $table, $updated_props, array( 'post_id' => $invoice->get_id() ) );
-			wp_cache_delete( $invoice->get_id(), 'getpaid_invoice_special_fields' );
-			do_action( "getpaid_invoice_update_database_fields", $invoice, $updated_props );
-
-		}
-
-	}
-
-	/**
-	 * Helper method that inserts special fields to the database.
-	 *
-	 * @param WPInv_Invoice $invoice WPInv_Invoice object.
-	 * @since 1.0.19
-	 */
-	protected function insert_special_fields( &$invoice ) {
-		global $wpdb;
-
-		$updated_props   = array();
-
-		foreach ( $this->database_fields_to_props as $database_field => $prop ) {
-			$value = $invoice->{"get_$prop"}( 'edit' );
-			$value = is_string( $value ) ? wp_slash( $value ) : $value;
-			$value = is_bool( $value ) ? ( int ) $value : $value;
-			$updated_props[ $database_field ] = maybe_serialize( $value );
-		}
-
-		$table = $wpdb->prefix . 'getpaid_invoices';
-		$wpdb->insert( $table, $updated_props );
-		wp_cache_delete( $invoice->get_id(), 'getpaid_invoice_special_fields' );
-		do_action( "getpaid_invoice_insert_database_fields", $invoice, $updated_props );
-
-	}
-
-	/**
+            if ( $db_field == 'post_id' ) {
+                continue;
+            }
+
+            $props[ $prop ] = $data[ $db_field ];
+        }
+
+        $invoice->set_props( $props );
+
+    }
+
+    /**
+     * Gets a list of special fields that need updated based on change state
+     * or if they are present in the database or not.
+     *
+     * @param  WPInv_Invoice $invoice       The Invoice object.
+     * @return array                        A mapping of field keys => prop names, filtered by ones that should be updated.
+     */
+    protected function get_special_fields_to_update( $invoice ) {
+        $fields_to_update = array();
+        $changed_props   = $invoice->get_changes();
+
+        // Props should be updated if they are a part of the $changed array or don't exist yet.
+        foreach ( $this->database_fields_to_props as $database_field => $prop ) {
+            if ( array_key_exists( $prop, $changed_props ) ) {
+                $fields_to_update[ $database_field ] = $prop;
+            }
+        }
+
+        return $fields_to_update;
+    }
+
+    /**
+     * Helper method that updates all the database fields for an invoice based on it's settings in the WPInv_Invoice class.
+     *
+     * @param WPInv_Invoice $invoice WPInv_Invoice object.
+     * @since 1.0.19
+     */
+    protected function update_special_fields( &$invoice ) {
+        global $wpdb;
+
+        $updated_props    = array();
+        $fields_to_update = $this->get_special_fields_to_update( $invoice );
+
+        foreach ( $fields_to_update as $database_field => $prop ) {
+            $value = $invoice->{"get_$prop"}( 'edit' );
+            $value = is_string( $value ) ? wp_slash( $value ) : $value;
+            $value = is_bool( $value ) ? ( int ) $value : $value;
+            $updated_props[ $database_field ] = maybe_serialize( $value );
+        }
+
+        if ( ! empty( $updated_props ) ) {
+
+            $table = $wpdb->prefix . 'getpaid_invoices';
+            $wpdb->update( $table, $updated_props, array( 'post_id' => $invoice->get_id() ) );
+            wp_cache_delete( $invoice->get_id(), 'getpaid_invoice_special_fields' );
+            do_action( "getpaid_invoice_update_database_fields", $invoice, $updated_props );
+
+        }
+
+    }
+
+    /**
+     * Helper method that inserts special fields to the database.
+     *
+     * @param WPInv_Invoice $invoice WPInv_Invoice object.
+     * @since 1.0.19
+     */
+    protected function insert_special_fields( &$invoice ) {
+        global $wpdb;
+
+        $updated_props   = array();
+
+        foreach ( $this->database_fields_to_props as $database_field => $prop ) {
+            $value = $invoice->{"get_$prop"}( 'edit' );
+            $value = is_string( $value ) ? wp_slash( $value ) : $value;
+            $value = is_bool( $value ) ? ( int ) $value : $value;
+            $updated_props[ $database_field ] = maybe_serialize( $value );
+        }
+
+        $table = $wpdb->prefix . 'getpaid_invoices';
+        $wpdb->insert( $table, $updated_props );
+        wp_cache_delete( $invoice->get_id(), 'getpaid_invoice_special_fields' );
+        do_action( "getpaid_invoice_insert_database_fields", $invoice, $updated_props );
+
+    }
+
+    /**
      * Saves all special fields.
-	 *
-	 * @param WPInv_Invoice $invoice Invoice object.
+     *
+     * @param WPInv_Invoice $invoice Invoice object.
      */
     public function save_special_fields( & $invoice ) {
-		global $wpdb;
+        global $wpdb;
 
-		// The invoices table.
-		$table = $wpdb->prefix . 'getpaid_invoices';
-		$id    = (int) $invoice->get_id();
-		$invoice->maybe_set_key();
+        // The invoices table.
+        $table = $wpdb->prefix . 'getpaid_invoices';
+        $id    = (int) $invoice->get_id();
+        $invoice->maybe_set_key();
 
-		if ( $wpdb->get_var( "SELECT `post_id` FROM $table WHERE `post_id`= $id" ) ) {
+        if ( $wpdb->get_var( "SELECT `post_id` FROM $table WHERE `post_id`= $id" ) ) {
 
-			$this->update_special_fields( $invoice );
+            $this->update_special_fields( $invoice );
 
-		} else {
+        } else {
 
-			$this->insert_special_fields( $invoice );
+            $this->insert_special_fields( $invoice );
 
-		}
+        }
 
-	}
+    }
 
-	/**
+    /**
      * Set's up cart details.
-	 *
-	 * @param WPInv_Invoice $invoice Invoice object.
+     *
+     * @param WPInv_Invoice $invoice Invoice object.
      */
     public function add_items( &$invoice ) {
-		global $wpdb;
+        global $wpdb;
 
-		// Maybe retrieve from the cache.
-		$items = wp_cache_get( $invoice->get_id(), 'getpaid_invoice_cart_details' );
+        // Maybe retrieve from the cache.
+        $items = wp_cache_get( $invoice->get_id(), 'getpaid_invoice_cart_details' );
 
-		// If not found, retrieve from the db.
-		if ( false === $items ) {
-			$table =  $wpdb->prefix . 'getpaid_invoice_items';
+        // If not found, retrieve from the db.
+        if ( false === $items ) {
+            $table =  $wpdb->prefix . 'getpaid_invoice_items';
 
-			$items = $wpdb->get_results(
-				$wpdb->prepare( "SELECT * FROM $table WHERE `post_id`=%d", $invoice->get_id() )
-			);
+            $items = $wpdb->get_results(
+                $wpdb->prepare( "SELECT * FROM $table WHERE `post_id`=%d", $invoice->get_id() )
+            );
 
-			// Update the cache with our data
-			wp_cache_set( $invoice->get_id(), $items, 'getpaid_invoice_cart_details' );
+            // Update the cache with our data
+            wp_cache_set( $invoice->get_id(), $items, 'getpaid_invoice_cart_details' );
 
-		}
+        }
 
-		// Abort if no items found.
+        // Abort if no items found.
         if ( empty( $items ) ) {
             return;
-		}
-
-		$_items = array();
-		foreach ( $items as $item_data ) {
-			$item = new GetPaid_Form_Item( $item_data->item_id );
-
-			// Set item data.
-			$item->item_tax      = wpinv_sanitize_amount( $item_data->tax );
-			$item->item_discount = wpinv_sanitize_amount( $item_data->discount );
-			$item->set_name( $item_data->item_name );
-			$item->set_description( $item_data->item_description );
-			$item->set_price( $item_data->item_price );
-			$item->set_quantity( $item_data->quantity );
-			$item->set_item_meta( $item_data->meta );
-			$_items[] = $item;
-		}
-
-		$invoice->set_items( $_items );
-	}
-
-	/**
+        }
+
+        $_items = array();
+        foreach ( $items as $item_data ) {
+            $item = new GetPaid_Form_Item( $item_data->item_id );
+
+            // Set item data.
+            $item->item_tax      = wpinv_sanitize_amount( $item_data->tax );
+            $item->item_discount = wpinv_sanitize_amount( $item_data->discount );
+            $item->set_name( $item_data->item_name );
+            $item->set_description( $item_data->item_description );
+            $item->set_price( $item_data->item_price );
+            $item->set_quantity( $item_data->quantity );
+            $item->set_item_meta( $item_data->meta );
+            $_items[] = $item;
+        }
+
+        $invoice->set_items( $_items );
+    }
+
+    /**
      * Saves cart details.
-	 *
-	 * @param WPInv_Invoice $invoice Invoice object.
+     *
+     * @param WPInv_Invoice $invoice Invoice object.
      */
     public function save_items( $invoice ) {
 
-		// Delete previously existing items.
-		$this->delete_items( $invoice );
+        // Delete previously existing items.
+        $this->delete_items( $invoice );
 
-		$table   =  $GLOBALS['wpdb']->prefix . 'getpaid_invoice_items';
+        $table   =  $GLOBALS['wpdb']->prefix . 'getpaid_invoice_items';
 
-		foreach ( $invoice->get_cart_details() as $item_data ) {
-			$item_data = array_map( 'maybe_serialize', $item_data );
-			$GLOBALS['wpdb']->insert( $table, $item_data );
-		}
+        foreach ( $invoice->get_cart_details() as $item_data ) {
+            $item_data = array_map( 'maybe_serialize', $item_data );
+            $GLOBALS['wpdb']->insert( $table, $item_data );
+        }
 
-		wp_cache_delete( $invoice->get_id(), 'getpaid_invoice_cart_details' );
-		do_action( "getpaid_invoice_save_items", $invoice );
+        wp_cache_delete( $invoice->get_id(), 'getpaid_invoice_cart_details' );
+        do_action( "getpaid_invoice_save_items", $invoice );
 
-	}
+    }
 
-	/**
+    /**
      * Deletes an invoice's cart details from the database.
-	 *
-	 * @param WPInv_Invoice $invoice Invoice object.
+     *
+     * @param WPInv_Invoice $invoice Invoice object.
      */
     public function delete_items( $invoice ) {
-		$table =  $GLOBALS['wpdb']->prefix . 'getpaid_invoice_items';
-		return $GLOBALS['wpdb']->delete( $table, array( 'post_id' => $invoice->get_id() ) );
-	}
+        $table =  $GLOBALS['wpdb']->prefix . 'getpaid_invoice_items';
+        return $GLOBALS['wpdb']->delete( $table, array( 'post_id' => $invoice->get_id() ) );
+    }
 
-	/**
+    /**
      * Deletes an invoice's special fields from the database.
-	 *
-	 * @param WPInv_Invoice $invoice Invoice object.
+     *
+     * @param WPInv_Invoice $invoice Invoice object.
      */
     public function delete_special_fields( $invoice ) {
-		$table =  $GLOBALS['wpdb']->prefix . 'getpaid_invoices';
-		return $GLOBALS['wpdb']->delete( $table, array( 'post_id' => $invoice->get_id() ) );
-	}
+        $table =  $GLOBALS['wpdb']->prefix . 'getpaid_invoices';
+        return $GLOBALS['wpdb']->delete( $table, array( 'post_id' => $invoice->get_id() ) );
+    }
 	
-	/**
-	 * Get the status to save to the post object.
-	 *
-	 *
-	 * @since 1.0.19
-	 * @param  WPInv_Invoice $object GetPaid_Data object.
-	 * @return string
-	 */
-	protected function get_post_status( $object ) {
-		$object_status = $object->get_status( 'edit' );
-
-		if ( ! $object_status ) {
-			$object_status = $object->get_default_status();
-		}
-
-		return $object_status;
-	}
+    /**
+     * Get the status to save to the post object.
+     *
+     *
+     * @since 1.0.19
+     * @param  WPInv_Invoice $object GetPaid_Data object.
+     * @return string
+     */
+    protected function get_post_status( $object ) {
+        $object_status = $object->get_status( 'edit' );
+
+        if ( ! $object_status ) {
+            $object_status = $object->get_default_status();
+        }
+
+        return $object_status;
+    }
 
 }

includes/admin/class-wpinv-customers-table.php

Indentation +351 added lines, -351 removed lines

@@ -9,7 +9,7 @@ 
 
 // Load WP_List_Table if not loaded
 if ( ! class_exists( 'WP_List_Table' ) ) {
-	require_once ABSPATH . 'wp-admin/includes/class-wp-list-table.php';
+    require_once ABSPATH . 'wp-admin/includes/class-wp-list-table.php';
 }
 
 /**
@@ -21,354 +21,354 @@ 
  */
 class WPInv_Customers_Table extends WP_List_Table {
 
-	/**
-	 * @var int Number of items per page
-	 * @since 1.0.19
-	 */
-	public $per_page = 10;
-
-	/**
-	 * @var int Number of items
-	 * @since 1.0.19
-	 */
-	public $total = 0;
-
-	/**
-	 * Get things started
-	 *
-	 * @since 1.0.19
-	 * @see WP_List_Table::__construct()
-	 */
-	public function __construct() {
-
-		// Set parent defaults
-		parent::__construct( array(
-			'singular' => 'id',
-			'plural'   => 'ids',
-			'ajax'     => false,
-		) );
-
-	}
-
-	/**
-	 * Gets the name of the primary column.
-	 *
-	 * @since 1.0.19
-	 * @access protected
-	 *
-	 * @return string Name of the primary column.
-	 */
-	protected function get_primary_column_name() {
-		return 'name';
-	}
-
-	/**
-	 * This function renders most of the columns in the list table.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @param WP_User $item
-	 * @param string $column_name The name of the column
-	 *
-	 * @return string Column Name
-	 */
-	public function column_default( $item, $column_name ) {
-		$value = sanitize_text_field( get_user_meta( $item->ID, '_wpinv_' . $column_name, true ) );
-		return apply_filters( 'wpinv_customers_table_column' . $column_name, $value, $item );
-	}
-
-	/**
-	 * Displays the country column.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @param WP_User $user
-	 *
-	 * @return string Column Name
-	 */
-	public function column_country( $user ) {
-		$country = wpinv_sanitize_country( $user->_wpinv_country );
-		if ( $country ) {
-			$country = wpinv_country_name( $country );
-		}
-		return sanitize_text_field( $country );
-	}
-
-	/**
-	 * Displays the state column.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @param WP_User $user
-	 *
-	 * @return string Column Name
-	 */
-	public function column_state( $user ) {
-		$country = wpinv_sanitize_country( $user->_wpinv_country );
-		$state   = $user->_wpinv_state;
-		if ( $state ) {
-			$state = wpinv_state_name( $state, $country );
-		}
-
-		return sanitize_text_field( $state );
-	}
-
-	/**
-	 * Displays the signup column.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @param WP_User $user
-	 *
-	 * @return string Column Name
-	 */
-	public function column_signup( $user ) {
-		return getpaid_format_date_value( $user->user_registered );
-	}
-
-	/**
-	 * Displays the total spent column.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @param WP_User $user
-	 *
-	 * @return string Column Name
-	 */
-	public function column_total( $user ) {
-
-		$args = array(
-			'data'             => array(
-
-				'total'        => array(
-					'type'     => 'invoice_data',
-					'function' => 'SUM',
-					'name'     => 'total_sales',
-				)
-
-			),
-			'where'            => array(
-
-				'author'       => array(
-					'type'     => 'post_data',
-					'value'    => absint( $user->ID ),
-					'key'      => 'posts.post_author',
-					'operator' => '=',
-				),
-
-			),
-			'query_type'     => 'get_var',
-			'invoice_status' => array( 'wpi-renewal', 'wpi-processing', 'publish' ),
-		);
-
-		return wpinv_price( (float) GetPaid_Reports_Helper::get_invoice_report_data( $args ) );
-
-	}
-
-	/**
-	 * Displays the total spent column.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @param WP_User $user
-	 *
-	 * @return string Column Name
-	 */
-	public function column_invoices( $user ) {
-
-		$args = array(
-			'data'             => array(
-
-				'ID'           => array(
-					'type'     => 'post_data',
-					'function' => 'COUNT',
-					'name'     => 'count',
-					'distinct' => true,
-				),
-
-			),
-			'where'            => array(
-
-				'author'       => array(
-					'type'     => 'post_data',
-					'value'    => absint( $user->ID ),
-					'key'      => 'posts.post_author',
-					'operator' => '=',
-				),
-
-			),
-			'query_type'     => 'get_var',
-			'invoice_status' => array_keys( wpinv_get_invoice_statuses() ),
-		);
-
-		return absint( GetPaid_Reports_Helper::get_invoice_report_data( $args ) );
-
-	}
-
-	/**
-	 * Generates content for a single row of the table
-	 * @since 1.0.19
-	 *
-	 * @param int $item The user id.
-	 */
-	public function single_row( $item ) {
-		$item = get_user_by( 'id', $item );
-
-		if ( empty( $item ) ) {
-			return;
-		}
-
-		echo '<tr>';
-		$this->single_row_columns( $item );
-		echo '</tr>';
-	}
-
-	/**
-	 * Displays the customers name
-	 *
-	 * @param  WP_User $customer customer.
-	 * @return string
-	 */
-	public function column_name( $customer ) {
-
-		// Customer view URL.
-		$view_url    = esc_url( add_query_arg( 'user_id', $customer->ID, admin_url( 'user-edit.php' ) ) );
-		$row_actions = $this->row_actions(
-			array(
-				'view' => '<a href="' . $view_url . '#getpaid-fieldset-billing">' . __( 'Edit Details', 'invoicing' ) . '</a>',
-			)
-		);
-
-		// Get user's address.
-		$address = wpinv_get_user_address( $customer->ID );
-
-		// Customer email address.
-		$email       = sanitize_email( $customer->user_email );
-
-		// Customer's avatar.
-		$avatar = esc_url( get_avatar_url( $email ) );
-		$avatar = "<img src='$avatar' height='32' width='32'/>";
-
-		// Customer's name.
-		$name   = sanitize_text_field( "{$address['first_name']} {$address['last_name']}" );
-
-		if ( ! empty( $name ) ) {
-			$name = "<div style='overflow: hidden;height: 18px;'>$name</div>";
-		}
-
-		$email = "<div class='row-title'><a href='$view_url'>$email</a></div>";
-
-		return "<div style='display: flex;'><div>$avatar</div><div style='margin-left: 10px;'>$name<strong>$email</strong>$row_actions</div></div>";
-
-	}
-
-	/**
-	 * Retrieve the table columns
-	 *
-	 * @since 1.0.19
-	 * @return array $columns Array of all the list table columns
-	 */
-	public function get_columns() {
-
-		$columns = array(
-			'name'     => __( 'Name', 'invoicing' ),
-			'country'  => __( 'Country', 'invoicing' ),
-			'state'    => __( 'State', 'invoicing' ),
-			'city'     => __( 'City', 'invoicing' ),
-			'zip'      => __( 'ZIP', 'invoicing' ),
-			'address'  => __( 'Address', 'invoicing' ),
-			'phone'    => __( 'Phone', 'invoicing' ),
-			'company'  => __( 'Company', 'invoicing' ),
-			'invoices' => __( 'Invoices', 'invoicing' ),
-			'total'    => __( 'Total Spend', 'invoicing' ),
-			'signup'   => __( 'Date created', 'invoicing' ),
-		);
-		return apply_filters( 'wpinv_customers_table_columns', $columns );
-
-	}
-
-	/**
-	 * Retrieve the current page number
-	 *
-	 * @since 1.0.19
-	 * @return int Current page number
-	 */
-	public function get_paged() {
-		return isset( $_GET['paged'] ) ? absint( $_GET['paged'] ) : 1;
-	}
-
-	/**
-	 * Returns bulk actions.
-	 *
-	 * @since 1.0.19
-	 * @return void
-	 */
-	public function bulk_actions( $which = '' ) {
-		return array();
-	}
-
-	/**
-	 *  Prepares the display query
-	 */
-	public function prepare_query() {
-		global $wpdb;
-
-		$post_types = '';
-
-		foreach ( array_keys( getpaid_get_invoice_post_types() ) as $post_type ) {
-			$post_types .= $wpdb->prepare( "post_type=%s OR ", $post_type );
-		}
-
-		$post_types = rtrim( $post_types, ' OR' );
-
-		// Maybe search.
-		if ( ! empty( $_POST['s'] ) ) {
-			$users = get_users(
-				array(
-					'search'         => '*' . sanitize_text_field( urldecode( $_POST['s'] ) ) . '*',
-					'search_columns' => array( 'user_login', 'user_email', 'display_name' ),
-					'fields'         => 'ID',
-				)
-			);
-
-			$users      = implode( ', ', $users );
-			$post_types = "($post_types) AND ( post_author IN ( $users ) )";
-		}
-
-		// Users with invoices.
-    	$customers = $wpdb->get_col(
-			$wpdb->prepare(
-				"SELECT DISTINCT( post_author ) FROM $wpdb->posts WHERE $post_types LIMIT %d,%d",
-				$this->get_paged() * 10 - 10,
-				$this->per_page
-			)
-		);
-
-		$this->items = $customers;
-		$this->total = (int) $wpdb->get_var( "SELECT COUNT( DISTINCT( post_author ) ) FROM $wpdb->posts WHERE $post_types" );
-
-	}
-
-	/**
-	 * Setup the final data for the table
-	 *
-	 * @since 1.0.19
-	 * @return void
-	 */
-	public function prepare_items() {
-		$columns               = $this->get_columns();
-		$hidden                = array(); // No hidden columns
-		$sortable              = $this->get_sortable_columns();
-		$this->_column_headers = array( $columns, $hidden, $sortable );
-		$this->prepare_query();
-
-		$this->set_pagination_args(
-			array(
-			'total_items' => $this->total,
-			'per_page'    => $this->per_page,
-			'total_pages' => ceil( $this->total / $this->per_page )
-			)
-		);
-
-	}
+    /**
+     * @var int Number of items per page
+     * @since 1.0.19
+     */
+    public $per_page = 10;
+
+    /**
+     * @var int Number of items
+     * @since 1.0.19
+     */
+    public $total = 0;
+
+    /**
+     * Get things started
+     *
+     * @since 1.0.19
+     * @see WP_List_Table::__construct()
+     */
+    public function __construct() {
+
+        // Set parent defaults
+        parent::__construct( array(
+            'singular' => 'id',
+            'plural'   => 'ids',
+            'ajax'     => false,
+        ) );
+
+    }
+
+    /**
+     * Gets the name of the primary column.
+     *
+     * @since 1.0.19
+     * @access protected
+     *
+     * @return string Name of the primary column.
+     */
+    protected function get_primary_column_name() {
+        return 'name';
+    }
+
+    /**
+     * This function renders most of the columns in the list table.
+     *
+     * @since 1.0.19
+     *
+     * @param WP_User $item
+     * @param string $column_name The name of the column
+     *
+     * @return string Column Name
+     */
+    public function column_default( $item, $column_name ) {
+        $value = sanitize_text_field( get_user_meta( $item->ID, '_wpinv_' . $column_name, true ) );
+        return apply_filters( 'wpinv_customers_table_column' . $column_name, $value, $item );
+    }
+
+    /**
+     * Displays the country column.
+     *
+     * @since 1.0.19
+     *
+     * @param WP_User $user
+     *
+     * @return string Column Name
+     */
+    public function column_country( $user ) {
+        $country = wpinv_sanitize_country( $user->_wpinv_country );
+        if ( $country ) {
+            $country = wpinv_country_name( $country );
+        }
+        return sanitize_text_field( $country );
+    }
+
+    /**
+     * Displays the state column.
+     *
+     * @since 1.0.19
+     *
+     * @param WP_User $user
+     *
+     * @return string Column Name
+     */
+    public function column_state( $user ) {
+        $country = wpinv_sanitize_country( $user->_wpinv_country );
+        $state   = $user->_wpinv_state;
+        if ( $state ) {
+            $state = wpinv_state_name( $state, $country );
+        }
+
+        return sanitize_text_field( $state );
+    }
+
+    /**
+     * Displays the signup column.
+     *
+     * @since 1.0.19
+     *
+     * @param WP_User $user
+     *
+     * @return string Column Name
+     */
+    public function column_signup( $user ) {
+        return getpaid_format_date_value( $user->user_registered );
+    }
+
+    /**
+     * Displays the total spent column.
+     *
+     * @since 1.0.19
+     *
+     * @param WP_User $user
+     *
+     * @return string Column Name
+     */
+    public function column_total( $user ) {
+
+        $args = array(
+            'data'             => array(
+
+                'total'        => array(
+                    'type'     => 'invoice_data',
+                    'function' => 'SUM',
+                    'name'     => 'total_sales',
+                )
+
+            ),
+            'where'            => array(
+
+                'author'       => array(
+                    'type'     => 'post_data',
+                    'value'    => absint( $user->ID ),
+                    'key'      => 'posts.post_author',
+                    'operator' => '=',
+                ),
+
+            ),
+            'query_type'     => 'get_var',
+            'invoice_status' => array( 'wpi-renewal', 'wpi-processing', 'publish' ),
+        );
+
+        return wpinv_price( (float) GetPaid_Reports_Helper::get_invoice_report_data( $args ) );
+
+    }
+
+    /**
+     * Displays the total spent column.
+     *
+     * @since 1.0.19
+     *
+     * @param WP_User $user
+     *
+     * @return string Column Name
+     */
+    public function column_invoices( $user ) {
+
+        $args = array(
+            'data'             => array(
+
+                'ID'           => array(
+                    'type'     => 'post_data',
+                    'function' => 'COUNT',
+                    'name'     => 'count',
+                    'distinct' => true,
+                ),
+
+            ),
+            'where'            => array(
+
+                'author'       => array(
+                    'type'     => 'post_data',
+                    'value'    => absint( $user->ID ),
+                    'key'      => 'posts.post_author',
+                    'operator' => '=',
+                ),
+
+            ),
+            'query_type'     => 'get_var',
+            'invoice_status' => array_keys( wpinv_get_invoice_statuses() ),
+        );
+
+        return absint( GetPaid_Reports_Helper::get_invoice_report_data( $args ) );
+
+    }
+
+    /**
+     * Generates content for a single row of the table
+     * @since 1.0.19
+     *
+     * @param int $item The user id.
+     */
+    public function single_row( $item ) {
+        $item = get_user_by( 'id', $item );
+
+        if ( empty( $item ) ) {
+            return;
+        }
+
+        echo '<tr>';
+        $this->single_row_columns( $item );
+        echo '</tr>';
+    }
+
+    /**
+     * Displays the customers name
+     *
+     * @param  WP_User $customer customer.
+     * @return string
+     */
+    public function column_name( $customer ) {
+
+        // Customer view URL.
+        $view_url    = esc_url( add_query_arg( 'user_id', $customer->ID, admin_url( 'user-edit.php' ) ) );
+        $row_actions = $this->row_actions(
+            array(
+                'view' => '<a href="' . $view_url . '#getpaid-fieldset-billing">' . __( 'Edit Details', 'invoicing' ) . '</a>',
+            )
+        );
+
+        // Get user's address.
+        $address = wpinv_get_user_address( $customer->ID );
+
+        // Customer email address.
+        $email       = sanitize_email( $customer->user_email );
+
+        // Customer's avatar.
+        $avatar = esc_url( get_avatar_url( $email ) );
+        $avatar = "<img src='$avatar' height='32' width='32'/>";
+
+        // Customer's name.
+        $name   = sanitize_text_field( "{$address['first_name']} {$address['last_name']}" );
+
+        if ( ! empty( $name ) ) {
+            $name = "<div style='overflow: hidden;height: 18px;'>$name</div>";
+        }
+
+        $email = "<div class='row-title'><a href='$view_url'>$email</a></div>";
+
+        return "<div style='display: flex;'><div>$avatar</div><div style='margin-left: 10px;'>$name<strong>$email</strong>$row_actions</div></div>";
+
+    }
+
+    /**
+     * Retrieve the table columns
+     *
+     * @since 1.0.19
+     * @return array $columns Array of all the list table columns
+     */
+    public function get_columns() {
+
+        $columns = array(
+            'name'     => __( 'Name', 'invoicing' ),
+            'country'  => __( 'Country', 'invoicing' ),
+            'state'    => __( 'State', 'invoicing' ),
+            'city'     => __( 'City', 'invoicing' ),
+            'zip'      => __( 'ZIP', 'invoicing' ),
+            'address'  => __( 'Address', 'invoicing' ),
+            'phone'    => __( 'Phone', 'invoicing' ),
+            'company'  => __( 'Company', 'invoicing' ),
+            'invoices' => __( 'Invoices', 'invoicing' ),
+            'total'    => __( 'Total Spend', 'invoicing' ),
+            'signup'   => __( 'Date created', 'invoicing' ),
+        );
+        return apply_filters( 'wpinv_customers_table_columns', $columns );
+
+    }
+
+    /**
+     * Retrieve the current page number
+     *
+     * @since 1.0.19
+     * @return int Current page number
+     */
+    public function get_paged() {
+        return isset( $_GET['paged'] ) ? absint( $_GET['paged'] ) : 1;
+    }
+
+    /**
+     * Returns bulk actions.
+     *
+     * @since 1.0.19
+     * @return void
+     */
+    public function bulk_actions( $which = '' ) {
+        return array();
+    }
+
+    /**
+     *  Prepares the display query
+     */
+    public function prepare_query() {
+        global $wpdb;
+
+        $post_types = '';
+
+        foreach ( array_keys( getpaid_get_invoice_post_types() ) as $post_type ) {
+            $post_types .= $wpdb->prepare( "post_type=%s OR ", $post_type );
+        }
+
+        $post_types = rtrim( $post_types, ' OR' );
+
+        // Maybe search.
+        if ( ! empty( $_POST['s'] ) ) {
+            $users = get_users(
+                array(
+                    'search'         => '*' . sanitize_text_field( urldecode( $_POST['s'] ) ) . '*',
+                    'search_columns' => array( 'user_login', 'user_email', 'display_name' ),
+                    'fields'         => 'ID',
+                )
+            );
+
+            $users      = implode( ', ', $users );
+            $post_types = "($post_types) AND ( post_author IN ( $users ) )";
+        }
+
+        // Users with invoices.
+        $customers = $wpdb->get_col(
+            $wpdb->prepare(
+                "SELECT DISTINCT( post_author ) FROM $wpdb->posts WHERE $post_types LIMIT %d,%d",
+                $this->get_paged() * 10 - 10,
+                $this->per_page
+            )
+        );
+
+        $this->items = $customers;
+        $this->total = (int) $wpdb->get_var( "SELECT COUNT( DISTINCT( post_author ) ) FROM $wpdb->posts WHERE $post_types" );
+
+    }
+
+    /**
+     * Setup the final data for the table
+     *
+     * @since 1.0.19
+     * @return void
+     */
+    public function prepare_items() {
+        $columns               = $this->get_columns();
+        $hidden                = array(); // No hidden columns
+        $sortable              = $this->get_sortable_columns();
+        $this->_column_headers = array( $columns, $hidden, $sortable );
+        $this->prepare_query();
+
+        $this->set_pagination_args(
+            array(
+            'total_items' => $this->total,
+            'per_page'    => $this->per_page,
+            'total_pages' => ceil( $this->total / $this->per_page )
+            )
+        );
+
+    }
 }

includes/class-getpaid-template.php

Indentation +152 added lines, -152 removed lines

@@ -1,6 +1,6 @@ 
 <?php
 if ( ! defined( 'ABSPATH' ) ) {
-	exit;
+    exit;
 }
 
 /**
@@ -20,29 +20,29 @@ 
     public $templates_url;
 
     /**
-	 * Class constructor.
-	 *
-	 * @since 1.0.19
-	 */
-	public function __construct() {
+     * Class constructor.
+     *
+     * @since 1.0.19
+     */
+    public function __construct() {
 
         $this->templates_dir = apply_filters( 'getpaid_default_templates_dir', WPINV_PLUGIN_DIR . 'templates' );
         $this->templates_url = apply_filters( 'getpaid_default_templates_url', WPINV_PLUGIN_URL . 'templates' );
 
         // Oxygen plugin
-		if ( defined( 'CT_VERSION' ) ) {
-			add_filter( 'wpinv_locate_template', array( $this, 'oxygen_override_template' ), 11, 4 );
-		}
+        if ( defined( 'CT_VERSION' ) ) {
+            add_filter( 'wpinv_locate_template', array( $this, 'oxygen_override_template' ), 11, 4 );
+        }
 
     }
 
     /**
-	 * Checks if this is a preview page
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
-	public function is_preview() {
+     * Checks if this is a preview page
+     *
+     * @since 1.0.19
+     * @return bool
+     */
+    public function is_preview() {
         return 
             $this->is_divi_preview() ||
             $this->is_elementor_preview() ||
@@ -54,73 +54,73 @@ 
     }
 
     /**
-	 * Checks if this is an elementor preview page
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
-	public function is_elementor_preview() {
-		return isset( $_REQUEST['elementor-preview'] ) || ( is_admin() && isset( $_REQUEST['action'] ) && $_REQUEST['action'] == 'elementor' ) || ( isset( $_REQUEST['action'] ) && $_REQUEST['action'] == 'elementor_ajax' );
-	}
-
-	/**
-	 * Checks if this is a DIVI preview page
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
-	public function is_divi_preview() {
-		return isset( $_REQUEST['et_fb'] ) || isset( $_REQUEST['et_pb_preview'] ) || ( is_admin() && isset( $_REQUEST['action'] ) && $_REQUEST['action'] == 'et_pb' );
-	}
-
-	/**
-	 * Checks if this is a beaver builder preview page
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
-	public function is_beaver_preview() {
-		return isset( $_REQUEST['fl_builder'] );
-	}
-
-	/**
-	 * Checks if this is a siteorigin builder preview page
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
-	public function is_siteorigin_preview() {
-		return ! empty( $_REQUEST['siteorigin_panels_live_editor'] );
-	}
-
-	/**
-	 * Checks if this is a cornerstone builder preview page
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
-	public function is_cornerstone_preview() {
-		return ! empty( $_REQUEST['cornerstone_preview'] ) || basename( $_SERVER['REQUEST_URI'] ) == 'cornerstone-endpoint';
-	}
-
-	/**
-	 * Checks if this is a fusion builder preview page
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
-	public function is_fusion_preview() {
-		return ! empty( $_REQUEST['fb-edit'] ) || ! empty( $_REQUEST['fusion_load_nonce'] );
-	}
-
-	/**
-	 * Checks if this is an oxygen builder preview page
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
-	public function is_oxygen_preview() {
-		return ! empty( $_REQUEST['ct_builder'] ) || ( ! empty( $_REQUEST['action'] ) && ( substr( $_REQUEST['action'], 0, 11 ) === "oxy_render_" || substr( $_REQUEST['action'], 0, 10 ) === "ct_render_" ) );
+     * Checks if this is an elementor preview page
+     *
+     * @since 1.0.19
+     * @return bool
+     */
+    public function is_elementor_preview() {
+        return isset( $_REQUEST['elementor-preview'] ) || ( is_admin() && isset( $_REQUEST['action'] ) && $_REQUEST['action'] == 'elementor' ) || ( isset( $_REQUEST['action'] ) && $_REQUEST['action'] == 'elementor_ajax' );
+    }
+
+    /**
+     * Checks if this is a DIVI preview page
+     *
+     * @since 1.0.19
+     * @return bool
+     */
+    public function is_divi_preview() {
+        return isset( $_REQUEST['et_fb'] ) || isset( $_REQUEST['et_pb_preview'] ) || ( is_admin() && isset( $_REQUEST['action'] ) && $_REQUEST['action'] == 'et_pb' );
+    }
+
+    /**
+     * Checks if this is a beaver builder preview page
+     *
+     * @since 1.0.19
+     * @return bool
+     */
+    public function is_beaver_preview() {
+        return isset( $_REQUEST['fl_builder'] );
+    }
+
+    /**
+     * Checks if this is a siteorigin builder preview page
+     *
+     * @since 1.0.19
+     * @return bool
+     */
+    public function is_siteorigin_preview() {
+        return ! empty( $_REQUEST['siteorigin_panels_live_editor'] );
+    }
+
+    /**
+     * Checks if this is a cornerstone builder preview page
+     *
+     * @since 1.0.19
+     * @return bool
+     */
+    public function is_cornerstone_preview() {
+        return ! empty( $_REQUEST['cornerstone_preview'] ) || basename( $_SERVER['REQUEST_URI'] ) == 'cornerstone-endpoint';
+    }
+
+    /**
+     * Checks if this is a fusion builder preview page
+     *
+     * @since 1.0.19
+     * @return bool
+     */
+    public function is_fusion_preview() {
+        return ! empty( $_REQUEST['fb-edit'] ) || ! empty( $_REQUEST['fusion_load_nonce'] );
+    }
+
+    /**
+     * Checks if this is an oxygen builder preview page
+     *
+     * @since 1.0.19
+     * @return bool
+     */
+    public function is_oxygen_preview() {
+        return ! empty( $_REQUEST['ct_builder'] ) || ( ! empty( $_REQUEST['action'] ) && ( substr( $_REQUEST['action'], 0, 11 ) === "oxy_render_" || substr( $_REQUEST['action'], 0, 10 ) === "ct_render_" ) );
     }
 
     /**
@@ -130,7 +130,7 @@ 
      * @param string $template_path The template path relative to the theme's root dir. Defaults to 'invoicing'.
      * @param string $default_path The root path to the default template. Defaults to invoicing/templates
      */
-	public function locate_template( $template_name, $template_path = '', $default_path = '' ) {
+    public function locate_template( $template_name, $template_path = '', $default_path = '' ) {
 
         // Load the defaults for the template path and default path.
         $template_path = empty( $template_path ) ? 'invoicing' : $template_path;
@@ -151,22 +151,22 @@ 
     }
     
     /**
-	 * Loads a template
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
-	protected function load_template( $template_name, $template_path, $args ) {
+     * Loads a template
+     *
+     * @since 1.0.19
+     * @return bool
+     */
+    protected function load_template( $template_name, $template_path, $args ) {
 
         if ( is_array( $args ) ){
             extract( $args );
         }
 
         // Fires before loading a template.
-	    do_action( 'wpinv_before_template_part', $template_name, $template_path, $args );
+        do_action( 'wpinv_before_template_part', $template_name, $template_path, $args );
 
         // Load the template.
-	    include( $template_path );
+        include( $template_path );
 
         // Fires after loading a template.
         do_action( 'wpinv_after_template_part', $template_name, $template_path, $args );
@@ -183,7 +183,7 @@ 
      * @param string $template_path The templates directory relative to the theme's root dir. Defaults to 'invoicing'.
      * @param string $default_path The root path to the default template. Defaults to invoicing/templates
      */
-	public function display_template( $template_name, $args = array(), $template_path = '', $default_path = '' ) {
+    public function display_template( $template_name, $args = array(), $template_path = '', $default_path = '' ) {
 
         // Locate the template.
         $located = $this->locate_template( $template_name, $template_path, $default_path );
@@ -208,74 +208,74 @@ 
      * @param string $template_path The templates directory relative to the theme's root dir. Defaults to 'invoicing'.
      * @param string $default_path The root path to the default template. Defaults to invoicing/templates
      */
-	public function get_template( $template_name, $args = array(), $template_path = '', $default_path = '' ) {
+    public function get_template( $template_name, $args = array(), $template_path = '', $default_path = '' ) {
         ob_start();
         $this->display_template( $template_name, $args, $template_path, $default_path );
         return ob_get_clean();
     }
 
     /**
-	 * Get the geodirectory templates theme path.
-	 *
-	 *
-	 * @return string Template path.
-	 */
-	public static function get_theme_template_path() {
-		$template   = get_template();
-		$theme_root = get_theme_root( $template );
-
-		return $theme_root . '/' . $template . '/' . untrailingslashit( wpinv_get_theme_template_dir_name() );
-
-	}
-
-	/**
-	 * Oxygen locate theme template.
-	 *
-	 * @param string $template The template.
-	 * @return string The theme template.
-	 */
-	public static function oxygen_locate_template( $template ) {
-
-		if ( empty( $template ) ) {
-			return '';
-		}
-
-		$has_filter = has_filter( 'template', 'ct_oxygen_template_name' );
-
-		// Remove template filter
-		if ( $has_filter ) {
-			remove_filter( 'template', 'ct_oxygen_template_name' );
-		}
-
-		$template = self::get_theme_template_path() . '/' . $template;
-
-		if ( ! file_exists( $template ) ) {
-			$template = '';
-		}
-
-		// Add template filter
-		if ( $has_filter ) {
-			add_filter( 'template', 'ct_oxygen_template_name' );
-		}
-
-		return $template;
-	}
-
-	/**
-	 * Oxygen override theme template.
-	 *
-	 * @param string $located Located template.
-	 * @param string $template_name Template name.
-	 * @return string Located template.
-	 */
-	public function oxygen_override_template( $located, $template_name ) {
+     * Get the geodirectory templates theme path.
+     *
+     *
+     * @return string Template path.
+     */
+    public static function get_theme_template_path() {
+        $template   = get_template();
+        $theme_root = get_theme_root( $template );
+
+        return $theme_root . '/' . $template . '/' . untrailingslashit( wpinv_get_theme_template_dir_name() );
+
+    }
+
+    /**
+     * Oxygen locate theme template.
+     *
+     * @param string $template The template.
+     * @return string The theme template.
+     */
+    public static function oxygen_locate_template( $template ) {
+
+        if ( empty( $template ) ) {
+            return '';
+        }
+
+        $has_filter = has_filter( 'template', 'ct_oxygen_template_name' );
+
+        // Remove template filter
+        if ( $has_filter ) {
+            remove_filter( 'template', 'ct_oxygen_template_name' );
+        }
+
+        $template = self::get_theme_template_path() . '/' . $template;
+
+        if ( ! file_exists( $template ) ) {
+            $template = '';
+        }
+
+        // Add template filter
+        if ( $has_filter ) {
+            add_filter( 'template', 'ct_oxygen_template_name' );
+        }
+
+        return $template;
+    }
+
+    /**
+     * Oxygen override theme template.
+     *
+     * @param string $located Located template.
+     * @param string $template_name Template name.
+     * @return string Located template.
+     */
+    public function oxygen_override_template( $located, $template_name ) {
 
         $oxygen_overide = self::oxygen_locate_template( $template_name );
-		if ( ! empty( $oxygen_overide ) ) {
-			return $oxygen_overide;
-		}
+        if ( ! empty( $oxygen_overide ) ) {
+            return $oxygen_overide;
+        }
 
-		return $located;
-	}
+        return $located;
+    }
 
 }

includes/payments/class-getpaid-form-item.php

Indentation +363 added lines, -363 removed lines

@@ -1,6 +1,6 @@ 
 <?php
 if ( ! defined( 'ABSPATH' ) ) {
-	exit;
+    exit;
 }
 
 /**
@@ -10,67 +10,67 @@ 
 class GetPaid_Form_Item  extends WPInv_Item {
 
     /**
-	 * Stores a custom description for the item.
-	 *
-	 * @var string
-	 */
-	protected $custom_description = null;
-
-	/**
-	 * Stores the item quantity.
-	 *
-	 * @var float
-	 */
-	protected $quantity = 1;
-
-	/**
-	 * Stores the item meta.
-	 *
-	 * @var array
-	 */
-	protected $meta = array();
-
-	/**
-	 * Is this item required?
-	 *
-	 * @var int
-	 */
-	protected $is_required = true;
-
-	/**
-	 * Are quantities allowed?
-	 *
-	 * @var int
-	 */
-	protected $allow_quantities = false;
-
-	/**
-	 * Associated invoice.
-	 *
-	 * @var int
-	 */
-	public $invoice_id = 0;
-
-	/**
-	 * Item discount.
-	 *
-	 * @var float
-	 */
-	public $item_discount = 0;
-
-	/**
-	 * Recurring item discount.
-	 *
-	 * @var float
-	 */
-	public $recurring_item_discount = 0;
-
-	/**
-	 * Item tax.
-	 *
-	 * @var float
-	 */
-	public $item_tax = 0;
+     * Stores a custom description for the item.
+     *
+     * @var string
+     */
+    protected $custom_description = null;
+
+    /**
+     * Stores the item quantity.
+     *
+     * @var float
+     */
+    protected $quantity = 1;
+
+    /**
+     * Stores the item meta.
+     *
+     * @var array
+     */
+    protected $meta = array();
+
+    /**
+     * Is this item required?
+     *
+     * @var int
+     */
+    protected $is_required = true;
+
+    /**
+     * Are quantities allowed?
+     *
+     * @var int
+     */
+    protected $allow_quantities = false;
+
+    /**
+     * Associated invoice.
+     *
+     * @var int
+     */
+    public $invoice_id = 0;
+
+    /**
+     * Item discount.
+     *
+     * @var float
+     */
+    public $item_discount = 0;
+
+    /**
+     * Recurring item discount.
+     *
+     * @var float
+     */
+    public $recurring_item_discount = 0;
+
+    /**
+     * Item tax.
+     *
+     * @var float
+     */
+    public $item_tax = 0;
 
     /*
 	|--------------------------------------------------------------------------
@@ -88,234 +88,234 @@ 
     */
 
     /**
-	 * Get the item name.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_name( $context = 'view' ) {
-		$name = parent::get_name( $context );
-		return $name . wpinv_get_item_suffix( $this );
-	}
-
-	/**
-	 * Get the item name without a suffix.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_raw_name( $context = 'view' ) {
-		return parent::get_name( $context );
-	}
-
-	/**
-	 * Get the item description.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_description( $context = 'view' ) {
-
-		if ( isset( $this->custom_description ) ) {
-			return $this->custom_description;
-		}
-
-		return parent::get_description( $context );
-	}
-
-	/**
-	 * Returns the sub total.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return float
-	 */
-	public function get_sub_total( $context = 'view' ) {
-		return $this->get_quantity( $context ) * $this->get_initial_price( $context );
-	}
-
-	/**
-	 * Returns the recurring sub total.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return float
-	 */
-	public function get_recurring_sub_total( $context = 'view' ) {
-
-		if ( $this->is_recurring() ) {
-			return $this->get_quantity( $context ) * $this->get_price( $context );
-		}
-
-		return 0;
-	}
-
-	/**
-	 * @deprecated
-	 */
-	public function get_qantity( $context = 'view' ) {
-		return $this->get_quantity( $context );
-	}
-
-	/**
-	 * Get the item quantity.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return float
-	 */
-	public function get_quantity( $context = 'view' ) {
-		$quantity = (float) $this->quantity;
-
-		if ( empty( $quantity ) || 1 > $quantity ) {
-			$quantity = 1;
-		}
-
-		if ( 'view' == $context ) {
-			return apply_filters( 'getpaid_payment_form_item_quantity', $quantity, $this );
-		}
-
-		return $quantity;
-
-	}
-
-	/**
-	 * Get the item meta data.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return meta
-	 */
-	public function get_item_meta( $context = 'view' ) {
-		$meta = $this->meta;
-
-		if ( 'view' == $context ) {
-			return apply_filters( 'getpaid_payment_form_item_meta', $meta, $this );
-		}
-
-		return $meta;
-
-	}
-
-	/**
-	 * Returns whether or not customers can update the item quantity.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return bool
-	 */
-	public function get_allow_quantities( $context = 'view' ) {
-		$allow_quantities = (bool) $this->allow_quantities;
-
-		if ( 'view' == $context ) {
-			return apply_filters( 'getpaid_payment_form_item_allow_quantities', $allow_quantities, $this );
-		}
-
-		return $allow_quantities;
-
-	}
-
-	/**
-	 * Returns whether or not the item is required.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return bool
-	 */
-	public function get_is_required( $context = 'view' ) {
-		$is_required = (bool) $this->is_required;
-
-		if ( 'view' == $context ) {
-			return apply_filters( 'getpaid_payment_form_item_is_required', $is_required, $this );
-		}
-
-		return $is_required;
-
-	}
-
-	/**
-	 * Prepares form data for use.
-	 *
-	 * @since 1.0.19
-	 * @return array
-	 */
-	public function prepare_data_for_use( $required = null ) {
-
-		$required = is_null( $required ) ? $this->is_required() : $required;
-		return array(
-			'title'            => strip_tags( $this->get_name() ),
-			'id'               => $this->get_id(),
-			'price'            => $this->get_price(),
-			'recurring'        => $this->is_recurring(),
-			'description'      => $this->get_description(),
-			'allow_quantities' => $this->allows_quantities(),
-			'required'         => $required,
-		);
-
-	}
-
-	/**
-	 * Prepares form data for ajax use.
-	 *
-	 * @since 1.0.19
-	 * @return array
-	 */
-	public function prepare_data_for_invoice_edit_ajax( $currency = '', $is_renewal = false ) {
-
-		$description = getpaid_item_recurring_price_help_text( $this, $currency );
-
-		if ( $description ) {
-			$description = "<div class='getpaid-subscription-help-text'>$description</div>";
-		}
-
-		$price    = ! $is_renewal ? $this->get_price() : $this->get_recurring_price();
-		$subtotal = ! $is_renewal ? $this->get_sub_total() : $this->get_recurring_sub_total();
-		return array(
-			'id'     => $this->get_id(),
-			'texts'  => array(
-				'item-name'        => sanitize_text_field( $this->get_name() ),
-				'item-description' => wp_kses_post( $this->get_description() ) . $description,
-				'item-quantity'    => floatval( $this->get_quantity() ),
-				'item-price'       => wpinv_price( $price, $currency ),
-				'item-total'       => wpinv_price( $subtotal, $currency ),
-			),
-			'inputs' => array(
-				'item-id'          => $this->get_id(),
-				'item-name'        => sanitize_text_field( $this->get_name() ),
-				'item-description' => wp_kses_post( $this->get_description() ),
-				'item-quantity'    => floatval( $this->get_quantity() ),
-				'item-price'       => $price,
-			)
-		);
-
-	}
-
-	/**
-	 * Prepares form data for saving (cart_details).
-	 *
-	 * @since 1.0.19
-	 * @return array
-	 */
-	public function prepare_data_for_saving() {
-
-		return array(
-			'post_id'           => $this->invoice_id,
-			'item_id'           => $this->get_id(),
-			'item_name'         => sanitize_text_field( $this->get_raw_name() ),
-			'item_description'  => $this->get_description(),
-			'tax'               => $this->item_tax,
-			'item_price'        => $this->get_price(),
-			'quantity'          => (float) $this->get_quantity(),
-			'discount'          => $this->item_discount,
-			'subtotal'          => $this->get_sub_total(),
-			'price'             => $this->get_sub_total() + $this->item_tax - $this->item_discount,
-			'meta'              => $this->get_item_meta(),
-		);
-
-	}
+     * Get the item name.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_name( $context = 'view' ) {
+        $name = parent::get_name( $context );
+        return $name . wpinv_get_item_suffix( $this );
+    }
+
+    /**
+     * Get the item name without a suffix.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_raw_name( $context = 'view' ) {
+        return parent::get_name( $context );
+    }
+
+    /**
+     * Get the item description.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_description( $context = 'view' ) {
+
+        if ( isset( $this->custom_description ) ) {
+            return $this->custom_description;
+        }
+
+        return parent::get_description( $context );
+    }
+
+    /**
+     * Returns the sub total.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return float
+     */
+    public function get_sub_total( $context = 'view' ) {
+        return $this->get_quantity( $context ) * $this->get_initial_price( $context );
+    }
+
+    /**
+     * Returns the recurring sub total.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return float
+     */
+    public function get_recurring_sub_total( $context = 'view' ) {
+
+        if ( $this->is_recurring() ) {
+            return $this->get_quantity( $context ) * $this->get_price( $context );
+        }
+
+        return 0;
+    }
+
+    /**
+     * @deprecated
+     */
+    public function get_qantity( $context = 'view' ) {
+        return $this->get_quantity( $context );
+    }
+
+    /**
+     * Get the item quantity.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return float
+     */
+    public function get_quantity( $context = 'view' ) {
+        $quantity = (float) $this->quantity;
+
+        if ( empty( $quantity ) || 1 > $quantity ) {
+            $quantity = 1;
+        }
+
+        if ( 'view' == $context ) {
+            return apply_filters( 'getpaid_payment_form_item_quantity', $quantity, $this );
+        }
+
+        return $quantity;
+
+    }
+
+    /**
+     * Get the item meta data.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return meta
+     */
+    public function get_item_meta( $context = 'view' ) {
+        $meta = $this->meta;
+
+        if ( 'view' == $context ) {
+            return apply_filters( 'getpaid_payment_form_item_meta', $meta, $this );
+        }
+
+        return $meta;
+
+    }
+
+    /**
+     * Returns whether or not customers can update the item quantity.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return bool
+     */
+    public function get_allow_quantities( $context = 'view' ) {
+        $allow_quantities = (bool) $this->allow_quantities;
+
+        if ( 'view' == $context ) {
+            return apply_filters( 'getpaid_payment_form_item_allow_quantities', $allow_quantities, $this );
+        }
+
+        return $allow_quantities;
+
+    }
+
+    /**
+     * Returns whether or not the item is required.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return bool
+     */
+    public function get_is_required( $context = 'view' ) {
+        $is_required = (bool) $this->is_required;
+
+        if ( 'view' == $context ) {
+            return apply_filters( 'getpaid_payment_form_item_is_required', $is_required, $this );
+        }
+
+        return $is_required;
+
+    }
+
+    /**
+     * Prepares form data for use.
+     *
+     * @since 1.0.19
+     * @return array
+     */
+    public function prepare_data_for_use( $required = null ) {
+
+        $required = is_null( $required ) ? $this->is_required() : $required;
+        return array(
+            'title'            => strip_tags( $this->get_name() ),
+            'id'               => $this->get_id(),
+            'price'            => $this->get_price(),
+            'recurring'        => $this->is_recurring(),
+            'description'      => $this->get_description(),
+            'allow_quantities' => $this->allows_quantities(),
+            'required'         => $required,
+        );
+
+    }
+
+    /**
+     * Prepares form data for ajax use.
+     *
+     * @since 1.0.19
+     * @return array
+     */
+    public function prepare_data_for_invoice_edit_ajax( $currency = '', $is_renewal = false ) {
+
+        $description = getpaid_item_recurring_price_help_text( $this, $currency );
+
+        if ( $description ) {
+            $description = "<div class='getpaid-subscription-help-text'>$description</div>";
+        }
+
+        $price    = ! $is_renewal ? $this->get_price() : $this->get_recurring_price();
+        $subtotal = ! $is_renewal ? $this->get_sub_total() : $this->get_recurring_sub_total();
+        return array(
+            'id'     => $this->get_id(),
+            'texts'  => array(
+                'item-name'        => sanitize_text_field( $this->get_name() ),
+                'item-description' => wp_kses_post( $this->get_description() ) . $description,
+                'item-quantity'    => floatval( $this->get_quantity() ),
+                'item-price'       => wpinv_price( $price, $currency ),
+                'item-total'       => wpinv_price( $subtotal, $currency ),
+            ),
+            'inputs' => array(
+                'item-id'          => $this->get_id(),
+                'item-name'        => sanitize_text_field( $this->get_name() ),
+                'item-description' => wp_kses_post( $this->get_description() ),
+                'item-quantity'    => floatval( $this->get_quantity() ),
+                'item-price'       => $price,
+            )
+        );
+
+    }
+
+    /**
+     * Prepares form data for saving (cart_details).
+     *
+     * @since 1.0.19
+     * @return array
+     */
+    public function prepare_data_for_saving() {
+
+        return array(
+            'post_id'           => $this->invoice_id,
+            'item_id'           => $this->get_id(),
+            'item_name'         => sanitize_text_field( $this->get_raw_name() ),
+            'item_description'  => $this->get_description(),
+            'tax'               => $this->item_tax,
+            'item_price'        => $this->get_price(),
+            'quantity'          => (float) $this->get_quantity(),
+            'discount'          => $this->item_discount,
+            'subtotal'          => $this->get_sub_total(),
+            'price'             => $this->get_sub_total() + $this->item_tax - $this->item_discount,
+            'meta'              => $this->get_item_meta(),
+        );
+
+    }
 
     /*
 	|--------------------------------------------------------------------------
@@ -327,70 +327,70 @@ 
 	| object.
     */
 
-	/**
-	 * Set the item qantity.
-	 *
-	 * @since 1.0.19
-	 * @param  float $quantity The item quantity.
-	 */
-	public function set_quantity( $quantity ) {
-
-		if ( empty( $quantity ) || ! is_numeric( $quantity ) ) {
-			$quantity = 1;
-		}
-
-		$this->quantity = (float) $quantity;
-
-	}
-
-	/**
-	 * Set the item meta data.
-	 *
-	 * @since 1.0.19
-	 * @param  array $meta The item meta data.
-	 */
-	public function set_item_meta( $meta ) {
-		$this->meta = maybe_unserialize( $meta );
-	}
-
-	/**
-	 * Set whether or not the quantities are allowed.
-	 *
-	 * @since 1.0.19
-	 * @param  bool $allow_quantities
-	 */
-	public function set_allow_quantities( $allow_quantities ) {
-		$this->allow_quantities = (bool) $allow_quantities;
-	}
-
-	/**
-	 * Set whether or not the item is required.
-	 *
-	 * @since 1.0.19
-	 * @param  bool $is_required
-	 */
-	public function set_is_required( $is_required ) {
-		$this->is_required = (bool) $is_required;
-	}
-
-	/**
-	 * Sets the custom item description.
-	 *
-	 * @since 1.0.19
-	 * @param  string $description
-	 */
-	public function set_custom_description( $description ) {
-		$this->custom_description = $description;
-	}
+    /**
+     * Set the item qantity.
+     *
+     * @since 1.0.19
+     * @param  float $quantity The item quantity.
+     */
+    public function set_quantity( $quantity ) {
+
+        if ( empty( $quantity ) || ! is_numeric( $quantity ) ) {
+            $quantity = 1;
+        }
+
+        $this->quantity = (float) $quantity;
+
+    }
+
+    /**
+     * Set the item meta data.
+     *
+     * @since 1.0.19
+     * @param  array $meta The item meta data.
+     */
+    public function set_item_meta( $meta ) {
+        $this->meta = maybe_unserialize( $meta );
+    }
+
+    /**
+     * Set whether or not the quantities are allowed.
+     *
+     * @since 1.0.19
+     * @param  bool $allow_quantities
+     */
+    public function set_allow_quantities( $allow_quantities ) {
+        $this->allow_quantities = (bool) $allow_quantities;
+    }
+
+    /**
+     * Set whether or not the item is required.
+     *
+     * @since 1.0.19
+     * @param  bool $is_required
+     */
+    public function set_is_required( $is_required ) {
+        $this->is_required = (bool) $is_required;
+    }
+
+    /**
+     * Sets the custom item description.
+     *
+     * @since 1.0.19
+     * @param  string $description
+     */
+    public function set_custom_description( $description ) {
+        $this->custom_description = $description;
+    }
 
     /**
      * We do not want to save items to the database.
      * 
-	 * @return int item id
+     * @return int item id
      */
     public function save( $data = array() ) {
         return $this->get_id();
-	}
+    }
 
     /*
 	|--------------------------------------------------------------------------
@@ -402,23 +402,23 @@ 
 	*/
 
     /**
-	 * Checks whether the item has enabled dynamic pricing.
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
-	public function is_required() {
+     * Checks whether the item has enabled dynamic pricing.
+     *
+     * @since 1.0.19
+     * @return bool
+     */
+    public function is_required() {
         return (bool) $this->get_is_required();
-	}
-
-	/**
-	 * Checks whether users can edit the quantities.
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
-	public function allows_quantities() {
+    }
+
+    /**
+     * Checks whether users can edit the quantities.
+     *
+     * @since 1.0.19
+     * @return bool
+     */
+    public function allows_quantities() {
         return (bool) $this->get_allow_quantities();
-	}
+    }
 
 }

includes/wpinv-item-functions.php

Indentation +3 added lines, -3 removed lines

@@ -411,9 +411,9 @@
     $bill_times      = $item->get_recurring_limit();
 
     if ( ! empty( $bill_times ) ) {
-		$bill_times = $item->get_recurring_interval() * $bill_times;
-		$bill_times = getpaid_get_subscription_period_label( $item->get_recurring_period(), $bill_times );
-	}
+        $bill_times = $item->get_recurring_interval() * $bill_times;
+        $bill_times = getpaid_get_subscription_period_label( $item->get_recurring_period(), $bill_times );
+    }
 
     if ( $item instanceof GetPaid_Form_Item && false === $_initial_price ) {
         $initial_price   = wpinv_price( $item->get_sub_total(), $currency );

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

Indentation +41 added lines, -41 removed lines

@@ -14,51 +14,51 @@
  */
 class GetPaid_Payment_Exception extends Exception {
 
-	/**
-	 * Sanitized error code.
-	 *
-	 * @var string
-	 */
-	protected $error_code;
+    /**
+     * Sanitized error code.
+     *
+     * @var string
+     */
+    protected $error_code;
 
-	/**
-	 * Error extra data.
-	 *
-	 * @var array
-	 */
-	protected $error_data;
+    /**
+     * Error extra data.
+     *
+     * @var array
+     */
+    protected $error_data;
 
-	/**
-	 * Setup exception.
-	 *
-	 * @param string $code             Machine-readable error code, e.g `getpaid-discount-error`.
-	 * @param string $message          User-friendly translated error message, e.g. 'Discount is invalid'.
-	 * @param int    $http_status_code Proper HTTP status code to respond with, e.g. 400.
-	 * @param array  $data             Extra error data.
-	 */
-	public function __construct( $code, $message, $http_status_code = 400, $data = array() ) {
-		$this->error_code = $code;
-		$this->error_data = array_merge( array( 'status' => $http_status_code ), $data );
+    /**
+     * Setup exception.
+     *
+     * @param string $code             Machine-readable error code, e.g `getpaid-discount-error`.
+     * @param string $message          User-friendly translated error message, e.g. 'Discount is invalid'.
+     * @param int    $http_status_code Proper HTTP status code to respond with, e.g. 400.
+     * @param array  $data             Extra error data.
+     */
+    public function __construct( $code, $message, $http_status_code = 400, $data = array() ) {
+        $this->error_code = $code;
+        $this->error_data = array_merge( array( 'status' => $http_status_code ), $data );
 
-		parent::__construct( $message, $http_status_code );
-	}
+        parent::__construct( $message, $http_status_code );
+    }
 
-	/**
-	 * Returns the error code.
-	 *
-	 * @return string
-	 */
-	public function getErrorCode() {
-		return $this->error_code;
-	}
+    /**
+     * Returns the error code.
+     *
+     * @return string
+     */
+    public function getErrorCode() {
+        return $this->error_code;
+    }
 
-	/**
-	 * Returns error data.
-	 *
-	 * @return array
-	 */
-	public function getErrorData() {
-		return $this->error_data;
-	}
+    /**
+     * Returns error data.
+     *
+     * @return array
+     */
+    public function getErrorData() {
+        return $this->error_data;
+    }
 
 }

includes/payments/class-getpaid-payment-form-submission-discount.php

Indentation +154 added lines, -154 removed lines

@@ -12,162 +12,162 @@
  */
 class GetPaid_Payment_Form_Submission_Discount {
 
-	/**
-	 * Submission discounts.
-	 * @var array
-	 */
-	public $discounts = array();
+    /**
+     * Submission discounts.
+     * @var array
+     */
+    public $discounts = array();
+
+    /**
+     * Class constructor
+     *
+     * @param GetPaid_Payment_Form_Submission $submission
+     * @param float                           $initial_total
+     * @param float                           $recurring_total
+     */
+    public function __construct( $submission, $initial_total, $recurring_total ) {
+
+        // Process any existing invoice discounts.
+        if ( $submission->has_invoice() ) {
+            $this->discounts = $submission->get_invoice()->get_discounts();
+        }
+
+        // Do we have a discount?
+        $discount = $submission->get_field( 'discount' );
+
+        if ( empty( $discount ) ) {
+
+            if ( isset( $this->discounts['discount_code'] ) ) {
+                unset( $this->discounts['discount_code'] );
+            }
+
+            return;
+        }
+
+        // Processes the discount code.
+        $amount = max( $initial_total, $recurring_total );
+        $this->process_discount( $submission, $discount, $amount );
+
+    }
 
     /**
-	 * Class constructor
-	 *
-	 * @param GetPaid_Payment_Form_Submission $submission
-	 * @param float                           $initial_total
-	 * @param float                           $recurring_total
-	 */
-	public function __construct( $submission, $initial_total, $recurring_total ) {
-
-		// Process any existing invoice discounts.
-		if ( $submission->has_invoice() ) {
-			$this->discounts = $submission->get_invoice()->get_discounts();
-		}
-
-		// Do we have a discount?
-		$discount = $submission->get_field( 'discount' );
-
-		if ( empty( $discount ) ) {
-
-			if ( isset( $this->discounts['discount_code'] ) ) {
-				unset( $this->discounts['discount_code'] );
-			}
-
-			return;
-		}
-
-		// Processes the discount code.
-		$amount = max( $initial_total, $recurring_total );
-		$this->process_discount( $submission, $discount, $amount );
-
-	}
-
-	/**
-	 * Processes a submission discount.
-	 *
-	 * @param GetPaid_Payment_Form_Submission $submission
-	 * @param string                          $discount
-	 * @param float                           $amount
-	 */
-	public function process_discount( $submission, $discount, $amount ) {
-
-		// Fetch the discount.
-		$discount = new WPInv_Discount( $discount );
-
-		// Ensure it is active.
+     * Processes a submission discount.
+     *
+     * @param GetPaid_Payment_Form_Submission $submission
+     * @param string                          $discount
+     * @param float                           $amount
+     */
+    public function process_discount( $submission, $discount, $amount ) {
+
+        // Fetch the discount.
+        $discount = new WPInv_Discount( $discount );
+
+        // Ensure it is active.
         if ( ! $this->is_discount_active( $discount ) ) {
-			throw new GetPaid_Payment_Exception( '.getpaid-discount-field .getpaid-custom-payment-form-errors', __( 'Invalid or expired discount code', 'invoicing' ) );
-		}
-
-		// Exceeded limit.
-		if ( $discount->has_exceeded_limit() ) {
-			throw new GetPaid_Payment_Exception( '.getpaid-discount-field .getpaid-custom-payment-form-errors', __( 'This discount code has been used up', 'invoicing' ) );
-		}
-
-		// Validate usages.
-		$this->validate_single_use_discount( $submission, $discount );
-
-		// Validate amount.
-		$this->validate_discount_amount( $submission, $discount, $amount );
-
-		// Save the discount.
-		$this->discounts['discount_code'] = $this->calculate_discount( $submission, $discount );
-	}
-
-	/**
-	 * Validates a single use discount.
-	 *
-	 * @param WPInv_Discount                  $discount
-	 * @return bool
-	 */
-	public function is_discount_active(  $discount ) {
-		return $discount->exists() && $discount->is_active() && $discount->has_started() && ! $discount->is_expired();
-	}
-
-	/**
-	 * Returns a user's id or email.
-	 *
-	 * @param string $email
-	 * @return int|string|false
-	 */
-	public function get_user_id_or_email( $email ) {
-
-		if ( is_user_logged_in() ) {
-			return get_current_user_id();
-		}
-
-		return empty( $email ) ? false : sanitize_email( $email );
-	}
-
-	/**
-	 * Validates a single use discount.
-	 *
-	 * @param GetPaid_Payment_Form_Submission $submission
-	 * @param WPInv_Discount                  $discount
-	 */
-	public function validate_single_use_discount( $submission, $discount ) {
-
-		// Abort if it is not a single use discount.
-		if ( ! $discount->is_single_use() ) {
-			return;
-		}
-
-		// Ensure there is a valid billing email.
-		$user = $this->get_user_id_or_email( $submission->get_billing_email() );
-
-		if ( empty( $user ) ) {
-			throw new GetPaid_Payment_Exception( '.getpaid-discount-field .getpaid-custom-payment-form-errors', __( 'You need to either log in or enter your billing email before applying this discount', 'invoicing' ) );
-		}
-
-		// Has the user used this discount code before?
-		if ( ! $discount->is_valid_for_user( $user ) ) {
-			throw new GetPaid_Payment_Exception( '.getpaid-discount-field .getpaid-custom-payment-form-errors', __( 'You have already used this discount', 'invoicing' ) );
-		}
-
-	}
-
-	/**
-	 * Validates the discount's amount.
-	 *
-	 * @param GetPaid_Payment_Form_Submission $submission
-	 * @param WPInv_Discount         $discount
-	 * @param float                  $amount
-	 */
-	public function validate_discount_amount( $submission, $discount, $amount ) {
-
-		// Validate minimum amount.
-		if ( ! $discount->is_minimum_amount_met( $amount ) ) {
-			$min = wpinv_price( $discount->get_minimum_total(), $submission->get_currency() );
-			throw new GetPaid_Payment_Exception( '.getpaid-discount-field .getpaid-custom-payment-form-errors', sprintf( __( 'The minimum total for using this discount is %s', 'invoicing' ), $min ) );
-		}
-
-		// Validate the maximum amount.
-		if ( ! $discount->is_maximum_amount_met( $amount ) ) {
-			$max = wpinv_price( $discount->get_maximum_total(), $submission->get_currency() );
-			throw new GetPaid_Payment_Exception( '.getpaid-discount-field .getpaid-custom-payment-form-errors', sprintf( __( 'The maximum total for using this discount is %s', 'invoicing' ), $max ) );
-		}
-
-	}
-
-	/**
-	 * Calculates the discount code's amount.
-	 *
-	 * Ensure that the discount exists and has been validated before calling this method.
-	 *
-	 * @param GetPaid_Payment_Form_Submission $submission
-	 * @param WPInv_Discount                  $discount
-	 * @return array
-	 */
-	public function calculate_discount( $submission, $discount ) {
-		return getpaid_calculate_invoice_discount( $submission, $discount );
-	}
+            throw new GetPaid_Payment_Exception( '.getpaid-discount-field .getpaid-custom-payment-form-errors', __( 'Invalid or expired discount code', 'invoicing' ) );
+        }
+
+        // Exceeded limit.
+        if ( $discount->has_exceeded_limit() ) {
+            throw new GetPaid_Payment_Exception( '.getpaid-discount-field .getpaid-custom-payment-form-errors', __( 'This discount code has been used up', 'invoicing' ) );
+        }
+
+        // Validate usages.
+        $this->validate_single_use_discount( $submission, $discount );
+
+        // Validate amount.
+        $this->validate_discount_amount( $submission, $discount, $amount );
+
+        // Save the discount.
+        $this->discounts['discount_code'] = $this->calculate_discount( $submission, $discount );
+    }
+
+    /**
+     * Validates a single use discount.
+     *
+     * @param WPInv_Discount                  $discount
+     * @return bool
+     */
+    public function is_discount_active(  $discount ) {
+        return $discount->exists() && $discount->is_active() && $discount->has_started() && ! $discount->is_expired();
+    }
+
+    /**
+     * Returns a user's id or email.
+     *
+     * @param string $email
+     * @return int|string|false
+     */
+    public function get_user_id_or_email( $email ) {
+
+        if ( is_user_logged_in() ) {
+            return get_current_user_id();
+        }
+
+        return empty( $email ) ? false : sanitize_email( $email );
+    }
+
+    /**
+     * Validates a single use discount.
+     *
+     * @param GetPaid_Payment_Form_Submission $submission
+     * @param WPInv_Discount                  $discount
+     */
+    public function validate_single_use_discount( $submission, $discount ) {
+
+        // Abort if it is not a single use discount.
+        if ( ! $discount->is_single_use() ) {
+            return;
+        }
+
+        // Ensure there is a valid billing email.
+        $user = $this->get_user_id_or_email( $submission->get_billing_email() );
+
+        if ( empty( $user ) ) {
+            throw new GetPaid_Payment_Exception( '.getpaid-discount-field .getpaid-custom-payment-form-errors', __( 'You need to either log in or enter your billing email before applying this discount', 'invoicing' ) );
+        }
+
+        // Has the user used this discount code before?
+        if ( ! $discount->is_valid_for_user( $user ) ) {
+            throw new GetPaid_Payment_Exception( '.getpaid-discount-field .getpaid-custom-payment-form-errors', __( 'You have already used this discount', 'invoicing' ) );
+        }
+
+    }
+
+    /**
+     * Validates the discount's amount.
+     *
+     * @param GetPaid_Payment_Form_Submission $submission
+     * @param WPInv_Discount         $discount
+     * @param float                  $amount
+     */
+    public function validate_discount_amount( $submission, $discount, $amount ) {
+
+        // Validate minimum amount.
+        if ( ! $discount->is_minimum_amount_met( $amount ) ) {
+            $min = wpinv_price( $discount->get_minimum_total(), $submission->get_currency() );
+            throw new GetPaid_Payment_Exception( '.getpaid-discount-field .getpaid-custom-payment-form-errors', sprintf( __( 'The minimum total for using this discount is %s', 'invoicing' ), $min ) );
+        }
+
+        // Validate the maximum amount.
+        if ( ! $discount->is_maximum_amount_met( $amount ) ) {
+            $max = wpinv_price( $discount->get_maximum_total(), $submission->get_currency() );
+            throw new GetPaid_Payment_Exception( '.getpaid-discount-field .getpaid-custom-payment-form-errors', sprintf( __( 'The maximum total for using this discount is %s', 'invoicing' ), $max ) );
+        }
+
+    }
+
+    /**
+     * Calculates the discount code's amount.
+     *
+     * Ensure that the discount exists and has been validated before calling this method.
+     *
+     * @param GetPaid_Payment_Form_Submission $submission
+     * @param WPInv_Discount                  $discount
+     * @return array
+     */
+    public function calculate_discount( $submission, $discount ) {
+        return getpaid_calculate_invoice_discount( $submission, $discount );
+    }
 
 }

includes/reports/class-getpaid-reports-helper.php

Indentation +276 added lines, -276 removed lines

@@ -12,294 +12,294 @@
  */
 class GetPaid_Reports_Helper {
 
-	/**
-	 * Get report totals such as invoice totals and discount amounts.
-	 *
-	 * Data example:
-	 *
-	 * 'subtotal' => array(
-	 *     'type'     => 'invoice_data',
-	 *     'function' => 'SUM',
-	 *     'name'     => 'subtotal'
-	 * )
-	 *
-	 * @param  array $args
-	 * @return mixed depending on query_type
-	 */
-	public static function get_invoice_report_data( $args = array() ) {
-		global $wpdb;
-
-		$default_args = array(
-			'data'                  => array(), // The data to retrieve.
-			'where'                 => array(), // An array of where queries.
-			'query_type'            => 'get_row', // wpdb query to run.
-			'group_by'              => '', // What to group results by.
-			'order_by'              => '', // What to order by.
-			'limit'                 => '', // Results limit.
-			'filter_range'          => array(), // An array of before and after dates to limit results by.
-			'invoice_types'         => array( 'wpi_invoice' ), // An array of post types to retrieve.
-			'invoice_status'        => array( 'publish', 'wpi-processing', 'wpi-onhold' ),
-			'parent_invoice_status' => false, // Optionally filter by parent invoice status.
-		);
-
-		$args         = apply_filters( 'getpaid_reports_get_invoice_report_data_args', $args );
-		$args         = wp_parse_args( $args, $default_args );
-
-		extract( $args );
-
-		if ( empty( $data ) ) {
-			return '';
-		}
-
-		$query           = array();
-		$query['select'] = 'SELECT ' . implode( ',', self::prepare_invoice_data( $data ) );
-		$query['from']   = "FROM {$wpdb->posts} AS posts";
-		$query['join']   = implode( ' ', self::prepare_invoice_joins( $data + $where, ! empty( $parent_invoice_status ) ) );
-
-		$query['where']  = "
+    /**
+     * Get report totals such as invoice totals and discount amounts.
+     *
+     * Data example:
+     *
+     * 'subtotal' => array(
+     *     'type'     => 'invoice_data',
+     *     'function' => 'SUM',
+     *     'name'     => 'subtotal'
+     * )
+     *
+     * @param  array $args
+     * @return mixed depending on query_type
+     */
+    public static function get_invoice_report_data( $args = array() ) {
+        global $wpdb;
+
+        $default_args = array(
+            'data'                  => array(), // The data to retrieve.
+            'where'                 => array(), // An array of where queries.
+            'query_type'            => 'get_row', // wpdb query to run.
+            'group_by'              => '', // What to group results by.
+            'order_by'              => '', // What to order by.
+            'limit'                 => '', // Results limit.
+            'filter_range'          => array(), // An array of before and after dates to limit results by.
+            'invoice_types'         => array( 'wpi_invoice' ), // An array of post types to retrieve.
+            'invoice_status'        => array( 'publish', 'wpi-processing', 'wpi-onhold' ),
+            'parent_invoice_status' => false, // Optionally filter by parent invoice status.
+        );
+
+        $args         = apply_filters( 'getpaid_reports_get_invoice_report_data_args', $args );
+        $args         = wp_parse_args( $args, $default_args );
+
+        extract( $args );
+
+        if ( empty( $data ) ) {
+            return '';
+        }
+
+        $query           = array();
+        $query['select'] = 'SELECT ' . implode( ',', self::prepare_invoice_data( $data ) );
+        $query['from']   = "FROM {$wpdb->posts} AS posts";
+        $query['join']   = implode( ' ', self::prepare_invoice_joins( $data + $where, ! empty( $parent_invoice_status ) ) );
+
+        $query['where']  = "
 			WHERE 	posts.post_type 	IN ( '" . implode( "','", $invoice_types ) . "' )
 			";
 
-		if ( ! empty( $invoice_status ) ) {
-			$query['where'] .= "
+        if ( ! empty( $invoice_status ) ) {
+            $query['where'] .= "
 				AND 	posts.post_status 	IN ( '" . implode( "','", $invoice_status ) . "' )
 			";
-		}
-
-		if ( ! empty( $parent_invoice_status ) ) {
-			if ( ! empty( $invoice_status ) ) {
-				$query['where'] .= " AND ( parent.post_status IN ( '" . implode( "','", $parent_invoice_status ) . "' ) OR parent.ID IS NULL ) ";
-			} else {
-				$query['where'] .= " AND parent.post_status IN ( '" . implode( "','", $parent_invoice_status ) . "' ) ";
-			}
-		}
-
-		if ( ! empty( $filter_range['before'] ) ) {
-			$query['where'] .= "
+        }
+
+        if ( ! empty( $parent_invoice_status ) ) {
+            if ( ! empty( $invoice_status ) ) {
+                $query['where'] .= " AND ( parent.post_status IN ( '" . implode( "','", $parent_invoice_status ) . "' ) OR parent.ID IS NULL ) ";
+            } else {
+                $query['where'] .= " AND parent.post_status IN ( '" . implode( "','", $parent_invoice_status ) . "' ) ";
+            }
+        }
+
+        if ( ! empty( $filter_range['before'] ) ) {
+            $query['where'] .= "
 				AND 	posts.post_date < '" . date( 'Y-m-d H:i:s', strtotime( $filter_range['before'] ) ) . "'
 			";
-		}
+        }
 
-		if ( ! empty( $filter_range['after'] ) ) {
-			$query['where'] .= "
+        if ( ! empty( $filter_range['after'] ) ) {
+            $query['where'] .= "
 				AND 	posts.post_date > '" . date( 'Y-m-d H:i:s', strtotime( $filter_range['after'] ) ) . "'
 			";
-		}
+        }
 
-		if ( ! empty( $where ) ) {
+        if ( ! empty( $where ) ) {
 
-			foreach ( $where as $value ) {
+            foreach ( $where as $value ) {
 
-				if ( strtolower( $value['operator'] ) == 'in' || strtolower( $value['operator'] ) == 'not in' ) {
-
-					if ( is_array( $value['value'] ) ) {
-						$value['value'] = implode( "','", $value['value'] );
-					}
-
-					if ( ! empty( $value['value'] ) ) {
-						$where_value = "{$value['operator']} ('{$value['value']}')";
-					}
-				} else {
-					$where_value = "{$value['operator']} '{$value['value']}'";
-				}
-
-				if ( ! empty( $where_value ) ) {
-					$query['where'] .= " AND {$value['key']} {$where_value}";
-				}
-			}
-		}
-
-		if ( $group_by ) {
-			$query['group_by'] = "GROUP BY {$group_by}";
-		}
-
-		if ( $order_by ) {
-			$query['order_by'] = "ORDER BY {$order_by}";
-		}
-
-		if ( $limit ) {
-			$query['limit'] = "LIMIT {$limit}";
-		}
-
-		$query = apply_filters( 'getpaid_reports_get_invoice_report_query', $query, $data );
-		$query = implode( ' ', $query );
-
-		return self::execute( $query_type, $query );
-
-	}
-
-	/**
-	 * Prepares the data to select.
-	 *
-	 *
-	 * @param  array $data
-	 * @return array
-	 */
-	public static function prepare_invoice_data( $data ) {
-
-		$prepared = array();
-
-		foreach ( $data as $raw_key => $value ) {
-			$key      = sanitize_key( $raw_key );
-			$distinct = '';
-
-			if ( isset( $value['distinct'] ) ) {
-				$distinct = 'DISTINCT';
-			}
-
-			$get_key = self::get_invoice_table_key( $key, $value['type'] );
-
-			if ( false === $get_key ) {
-				// Skip to the next foreach iteration else the query will be invalid.
-				continue;
-			}
-
-			if ( ! empty( $value['function'] ) ) {
-				$get = "{$value['function']}({$distinct} {$get_key})";
-			} else {
-				$get = "{$distinct} {$get_key}";
-			}
-
-			$prepared[] = "{$get} as {$value['name']}";
-		}
-
-		return $prepared;
-
-	}
-
-	/**
-	 * Prepares the joins to use.
-	 *
-	 *
-	 * @param  array $data
-	 * @param  bool $with_parent
-	 * @return array
-	 */
-	public static function prepare_invoice_joins( $data, $with_parent ) {
-		global $wpdb;
-
-		$prepared = array();
-
-		foreach ( $data as $raw_key => $value ) {
-			$join_type = isset( $value['join_type'] ) ? $value['join_type'] : 'INNER';
-			$type      = isset( $value['type'] ) ? $value['type'] : false;
-			$key       = sanitize_key( $raw_key );
-
-			switch ( $type ) {
-				case 'meta':
-					$prepared[ "meta_{$key}" ] = "{$join_type} JOIN {$wpdb->postmeta} AS meta_{$key} ON ( posts.ID = meta_{$key}.post_id AND meta_{$key}.meta_key = '{$raw_key}' )";
-					break;
-				case 'parent_meta':
-					$prepared[ "parent_meta_{$key}" ] = "{$join_type} JOIN {$wpdb->postmeta} AS parent_meta_{$key} ON (posts.post_parent = parent_meta_{$key}.post_id) AND (parent_meta_{$key}.meta_key = '{$raw_key}')";
-					break;
-				case 'invoice_data':
-					$prepared['invoices'] = "{$join_type} JOIN {$wpdb->prefix}getpaid_invoices AS invoices ON posts.ID = invoices.post_id";
-					break;
-				case 'invoice_item':
-					$prepared['invoice_items'] = "{$join_type} JOIN {$wpdb->prefix}getpaid_invoice_items AS invoice_items ON posts.ID = invoice_items.post_id";
-					break;
-			}
-		}
-
-		if ( $with_parent ) {
-			$prepared['parent'] = "LEFT JOIN {$wpdb->posts} AS parent ON posts.post_parent = parent.ID";
-		}
-
-		return $prepared;
-
-	}
-
-	/**
-	 * Retrieves the appropriate table key to use.
-	 *
-	 *
-	 * @param  string $key
-	 * @param  string $table
-	 * @return string|false
-	 */
-	public static function get_invoice_table_key( $key, $table ) {
-
-		$keys = array(
-			'meta'         => "meta_{$key}.meta_value",
-			'parent_meta'  => "parent_meta_{$key}.meta_value",
-			'post_data'    => "posts.{$key}",
-			'invoice_data' => "invoices.{$key}",
-			'invoice_item' => "invoice_items.{$key}",
-		);
-
-		return isset( $keys[ $table ] ) ? $keys[ $table ] : false;
-
-	}
-
-	/**
-	 * Executes a query and caches the result for a minute.
-	 *
-	 *
-	 * @param  string $query_type
-	 * @param  string $query
-	 * @return mixed depending on query_type
-	 */
-	public static function execute( $query_type, $query ) {
-		global $wpdb;
-
-		$query_hash = md5( $query_type . $query );
-		$result     = self::get_cached_query( $query_hash );
-		if ( $result === false ) {
-			self::enable_big_selects();
-
-			$result = $wpdb->$query_type( $query );
-			self::set_cached_query( $query_hash, $result );
-		}
-
-		return $result;
-
-	}
-
-	/**
-	 * Enables big mysql selects for reports, just once for this session.
-	 */
-	protected static function enable_big_selects() {
-		static $big_selects = false;
-
-		global $wpdb;
-
-		if ( ! $big_selects ) {
-			$wpdb->query( 'SET SESSION SQL_BIG_SELECTS=1' );
-			$big_selects = true;
-		}
-	}
-
-	/**
-	 * Get the cached query result or null if it's not in the cache.
-	 *
-	 * @param string $query_hash The query hash.
-	 *
-	 * @return mixed|false The cache contents on success, false on failure to retrieve contents.
-	 */
-	protected static function get_cached_query( $query_hash ) {
-
-		return wp_cache_get(
-			$query_hash,
-			strtolower( __CLASS__ )
-		);
-
-	}
-
-	/**
-	 * Set the cached query result.
-	 *
-	 * @param string $query_hash The query hash.
-	 * @param mixed  $data The data to cache.
-	 */
-	protected static function set_cached_query( $query_hash, $data ) {
-
-		wp_cache_set(
-			$query_hash,
-			$data,
-			strtolower( __CLASS__ ),
-			MINUTE_IN_SECONDS
-		);
-
-	}
+                if ( strtolower( $value['operator'] ) == 'in' || strtolower( $value['operator'] ) == 'not in' ) {
+
+                    if ( is_array( $value['value'] ) ) {
+                        $value['value'] = implode( "','", $value['value'] );
+                    }
+
+                    if ( ! empty( $value['value'] ) ) {
+                        $where_value = "{$value['operator']} ('{$value['value']}')";
+                    }
+                } else {
+                    $where_value = "{$value['operator']} '{$value['value']}'";
+                }
+
+                if ( ! empty( $where_value ) ) {
+                    $query['where'] .= " AND {$value['key']} {$where_value}";
+                }
+            }
+        }
+
+        if ( $group_by ) {
+            $query['group_by'] = "GROUP BY {$group_by}";
+        }
+
+        if ( $order_by ) {
+            $query['order_by'] = "ORDER BY {$order_by}";
+        }
+
+        if ( $limit ) {
+            $query['limit'] = "LIMIT {$limit}";
+        }
+
+        $query = apply_filters( 'getpaid_reports_get_invoice_report_query', $query, $data );
+        $query = implode( ' ', $query );
+
+        return self::execute( $query_type, $query );
+
+    }
+
+    /**
+     * Prepares the data to select.
+     *
+     *
+     * @param  array $data
+     * @return array
+     */
+    public static function prepare_invoice_data( $data ) {
+
+        $prepared = array();
+
+        foreach ( $data as $raw_key => $value ) {
+            $key      = sanitize_key( $raw_key );
+            $distinct = '';
+
+            if ( isset( $value['distinct'] ) ) {
+                $distinct = 'DISTINCT';
+            }
+
+            $get_key = self::get_invoice_table_key( $key, $value['type'] );
+
+            if ( false === $get_key ) {
+                // Skip to the next foreach iteration else the query will be invalid.
+                continue;
+            }
+
+            if ( ! empty( $value['function'] ) ) {
+                $get = "{$value['function']}({$distinct} {$get_key})";
+            } else {
+                $get = "{$distinct} {$get_key}";
+            }
+
+            $prepared[] = "{$get} as {$value['name']}";
+        }
+
+        return $prepared;
+
+    }
+
+    /**
+     * Prepares the joins to use.
+     *
+     *
+     * @param  array $data
+     * @param  bool $with_parent
+     * @return array
+     */
+    public static function prepare_invoice_joins( $data, $with_parent ) {
+        global $wpdb;
+
+        $prepared = array();
+
+        foreach ( $data as $raw_key => $value ) {
+            $join_type = isset( $value['join_type'] ) ? $value['join_type'] : 'INNER';
+            $type      = isset( $value['type'] ) ? $value['type'] : false;
+            $key       = sanitize_key( $raw_key );
+
+            switch ( $type ) {
+                case 'meta':
+                    $prepared[ "meta_{$key}" ] = "{$join_type} JOIN {$wpdb->postmeta} AS meta_{$key} ON ( posts.ID = meta_{$key}.post_id AND meta_{$key}.meta_key = '{$raw_key}' )";
+                    break;
+                case 'parent_meta':
+                    $prepared[ "parent_meta_{$key}" ] = "{$join_type} JOIN {$wpdb->postmeta} AS parent_meta_{$key} ON (posts.post_parent = parent_meta_{$key}.post_id) AND (parent_meta_{$key}.meta_key = '{$raw_key}')";
+                    break;
+                case 'invoice_data':
+                    $prepared['invoices'] = "{$join_type} JOIN {$wpdb->prefix}getpaid_invoices AS invoices ON posts.ID = invoices.post_id";
+                    break;
+                case 'invoice_item':
+                    $prepared['invoice_items'] = "{$join_type} JOIN {$wpdb->prefix}getpaid_invoice_items AS invoice_items ON posts.ID = invoice_items.post_id";
+                    break;
+            }
+        }
+
+        if ( $with_parent ) {
+            $prepared['parent'] = "LEFT JOIN {$wpdb->posts} AS parent ON posts.post_parent = parent.ID";
+        }
+
+        return $prepared;
+
+    }
+
+    /**
+     * Retrieves the appropriate table key to use.
+     *
+     *
+     * @param  string $key
+     * @param  string $table
+     * @return string|false
+     */
+    public static function get_invoice_table_key( $key, $table ) {
+
+        $keys = array(
+            'meta'         => "meta_{$key}.meta_value",
+            'parent_meta'  => "parent_meta_{$key}.meta_value",
+            'post_data'    => "posts.{$key}",
+            'invoice_data' => "invoices.{$key}",
+            'invoice_item' => "invoice_items.{$key}",
+        );
+
+        return isset( $keys[ $table ] ) ? $keys[ $table ] : false;
+
+    }
+
+    /**
+     * Executes a query and caches the result for a minute.
+     *
+     *
+     * @param  string $query_type
+     * @param  string $query
+     * @return mixed depending on query_type
+     */
+    public static function execute( $query_type, $query ) {
+        global $wpdb;
+
+        $query_hash = md5( $query_type . $query );
+        $result     = self::get_cached_query( $query_hash );
+        if ( $result === false ) {
+            self::enable_big_selects();
+
+            $result = $wpdb->$query_type( $query );
+            self::set_cached_query( $query_hash, $result );
+        }
+
+        return $result;
+
+    }
+
+    /**
+     * Enables big mysql selects for reports, just once for this session.
+     */
+    protected static function enable_big_selects() {
+        static $big_selects = false;
+
+        global $wpdb;
+
+        if ( ! $big_selects ) {
+            $wpdb->query( 'SET SESSION SQL_BIG_SELECTS=1' );
+            $big_selects = true;
+        }
+    }
+
+    /**
+     * Get the cached query result or null if it's not in the cache.
+     *
+     * @param string $query_hash The query hash.
+     *
+     * @return mixed|false The cache contents on success, false on failure to retrieve contents.
+     */
+    protected static function get_cached_query( $query_hash ) {
+
+        return wp_cache_get(
+            $query_hash,
+            strtolower( __CLASS__ )
+        );
+
+    }
+
+    /**
+     * Set the cached query result.
+     *
+     * @param string $query_hash The query hash.
+     * @param mixed  $data The data to cache.
+     */
+    protected static function set_cached_query( $query_hash, $data ) {
+
+        wp_cache_set(
+            $query_hash,
+            $data,
+            strtolower( __CLASS__ ),
+            MINUTE_IN_SECONDS
+        );
+
+    }
 
 }

includes/class-wpinv-notes.php

Indentation +192 added lines, -192 removed lines

@@ -12,202 +12,202 @@
  */
 class WPInv_Notes {
 
-	/**
-	 * Class constructor.
-	 */
-	public function __construct() {
-
-		// Filter inovice notes.
-		add_action( 'pre_get_comments', array( $this, 'set_invoice_note_type' ), 11, 1 );
-		add_action( 'comment_feed_where', array( $this, 'wpinv_comment_feed_where' ), 10, 1 );
-
-		// Delete comments count cache whenever there is a new comment or a comment status changes.
-		add_action( 'wp_insert_comment', array( $this, 'delete_comments_count_cache' ) );
-		add_action( 'wp_set_comment_status', array( $this, 'delete_comments_count_cache' ) );
-
-		// Count comments.
-		add_filter( 'wp_count_comments', array( $this, 'wp_count_comments' ), 100, 2 );
-
-		// Fires after notes are loaded.
-		do_action( 'wpinv_notes_init', $this );
-	}
-
-	/**
-	 * Filters invoice notes query to only include our notes.
-	 *
-	 * @param WP_Comment_Query $query
-	 */
-	public function set_invoice_note_type( $query ) {
-		$post_id = ! empty( $query->query_vars['post_ID'] ) ? $query->query_vars['post_ID'] : $query->query_vars['post_id'];
-
-		if ( $post_id && getpaid_is_invoice_post_type( get_post_type( $post_id ) ) ) {
-			$query->query_vars['type'] = 'wpinv_note';
-		} else {
-
-			if ( empty( $query->query_vars['type__not_in'] ) ) {
-				$query->query_vars['type__not_in'] = array();
-			}
-
-			$query->query_vars['type__not_in'] = wpinv_parse_list( $query->query_vars['type__not_in'] );
-			$query->query_vars['type__not_in'] = array_merge( array( 'wpinv_note' ), $query->query_vars['type__not_in'] );
-		}
-
-		return $query;
-	}
-
-	/**
-	 * Exclude notes from the comments feed.
-	 */
-	function wpinv_comment_feed_where( $where ){
-		return $where . ( $where ? ' AND ' : '' ) . " comment_type != 'wpinv_note' ";
-	}
-
-	/**
-	 * Delete comments count cache whenever there is
-	 * new comment or the status of a comment changes. Cache
-	 * will be regenerated next time WPInv_Notes::wp_count_comments()
-	 * is called.
-	 */
-	public function delete_comments_count_cache() {
-		delete_transient( 'getpaid_count_comments' );
-	}
-
-	/**
-	 * Remove invoice notes from wp_count_comments().
-	 *
-	 * @since  2.2
-	 * @param  object $stats   Comment stats.
-	 * @param  int    $post_id Post ID.
-	 * @return object
-	 */
-	public function wp_count_comments( $stats, $post_id ) {
-		global $wpdb;
-
-		if ( empty( $post_id ) ) {
-			$stats = get_transient( 'getpaid_count_comments' );
-
-			if ( ! $stats ) {
-				$stats = array(
-					'total_comments' => 0,
-					'all'            => 0,
-				);
-
-				$count = $wpdb->get_results(
-					"
+    /**
+     * Class constructor.
+     */
+    public function __construct() {
+
+        // Filter inovice notes.
+        add_action( 'pre_get_comments', array( $this, 'set_invoice_note_type' ), 11, 1 );
+        add_action( 'comment_feed_where', array( $this, 'wpinv_comment_feed_where' ), 10, 1 );
+
+        // Delete comments count cache whenever there is a new comment or a comment status changes.
+        add_action( 'wp_insert_comment', array( $this, 'delete_comments_count_cache' ) );
+        add_action( 'wp_set_comment_status', array( $this, 'delete_comments_count_cache' ) );
+
+        // Count comments.
+        add_filter( 'wp_count_comments', array( $this, 'wp_count_comments' ), 100, 2 );
+
+        // Fires after notes are loaded.
+        do_action( 'wpinv_notes_init', $this );
+    }
+
+    /**
+     * Filters invoice notes query to only include our notes.
+     *
+     * @param WP_Comment_Query $query
+     */
+    public function set_invoice_note_type( $query ) {
+        $post_id = ! empty( $query->query_vars['post_ID'] ) ? $query->query_vars['post_ID'] : $query->query_vars['post_id'];
+
+        if ( $post_id && getpaid_is_invoice_post_type( get_post_type( $post_id ) ) ) {
+            $query->query_vars['type'] = 'wpinv_note';
+        } else {
+
+            if ( empty( $query->query_vars['type__not_in'] ) ) {
+                $query->query_vars['type__not_in'] = array();
+            }
+
+            $query->query_vars['type__not_in'] = wpinv_parse_list( $query->query_vars['type__not_in'] );
+            $query->query_vars['type__not_in'] = array_merge( array( 'wpinv_note' ), $query->query_vars['type__not_in'] );
+        }
+
+        return $query;
+    }
+
+    /**
+     * Exclude notes from the comments feed.
+     */
+    function wpinv_comment_feed_where( $where ){
+        return $where . ( $where ? ' AND ' : '' ) . " comment_type != 'wpinv_note' ";
+    }
+
+    /**
+     * Delete comments count cache whenever there is
+     * new comment or the status of a comment changes. Cache
+     * will be regenerated next time WPInv_Notes::wp_count_comments()
+     * is called.
+     */
+    public function delete_comments_count_cache() {
+        delete_transient( 'getpaid_count_comments' );
+    }
+
+    /**
+     * Remove invoice notes from wp_count_comments().
+     *
+     * @since  2.2
+     * @param  object $stats   Comment stats.
+     * @param  int    $post_id Post ID.
+     * @return object
+     */
+    public function wp_count_comments( $stats, $post_id ) {
+        global $wpdb;
+
+        if ( empty( $post_id ) ) {
+            $stats = get_transient( 'getpaid_count_comments' );
+
+            if ( ! $stats ) {
+                $stats = array(
+                    'total_comments' => 0,
+                    'all'            => 0,
+                );
+
+                $count = $wpdb->get_results(
+                    "
 					SELECT comment_approved, COUNT(*) AS num_comments
 					FROM {$wpdb->comments}
 					WHERE comment_type NOT IN ('action_log', 'order_note', 'webhook_delivery', 'wpinv_note')
 					GROUP BY comment_approved
 					",
-					ARRAY_A
-				);
-
-				$approved = array(
-					'0'            => 'moderated',
-					'1'            => 'approved',
-					'spam'         => 'spam',
-					'trash'        => 'trash',
-					'post-trashed' => 'post-trashed',
-				);
-
-				foreach ( (array) $count as $row ) {
-					// Don't count post-trashed toward totals.
-					if ( ! in_array( $row['comment_approved'], array( 'post-trashed', 'trash', 'spam' ), true ) ) {
-						$stats['all']            += $row['num_comments'];
-						$stats['total_comments'] += $row['num_comments'];
-					} elseif ( ! in_array( $row['comment_approved'], array( 'post-trashed', 'trash' ), true ) ) {
-						$stats['total_comments'] += $row['num_comments'];
-					}
-					if ( isset( $approved[ $row['comment_approved'] ] ) ) {
-						$stats[ $approved[ $row['comment_approved'] ] ] = $row['num_comments'];
-					}
-				}
-
-				foreach ( $approved as $key ) {
-					if ( empty( $stats[ $key ] ) ) {
-						$stats[ $key ] = 0;
-					}
-				}
-
-				$stats = (object) $stats;
-				set_transient( 'getpaid_count_comments', $stats );
-			}
-
-		}
-
-		return $stats;
-	}
-
-	/**
-	 * Returns an array of invoice notes.
-	 *
-	 * @param int $invoice_id The invoice ID whose notes to retrieve.
-	 * @param string $type Optional. Pass in customer to only return customer notes.
-	 * @return WP_Comment[]
-	 */
-	public function get_invoice_notes( $invoice_id = 0, $type = 'all' ) {
-
-		// Default comment args.
-		$args = array(
-			'post_id'   => $invoice_id,
-			'orderby'   => 'comment_ID',
-			'order'     => 'ASC',
-		);
-
-		// Maybe only show customer comments.
-		if ( $type == 'customer' ) {
-			$args['meta_key']   = '_wpi_customer_note';
-			$args['meta_value'] = 1;
-		}
-
-		$args = apply_filters( 'wpinv_invoice_notes_args', $args, $this, $invoice_id, $type );
-
-		return get_comments( $args );
-	}
-
-	/**
-	 * Saves an invoice comment.
-	 * 
-	 * @param WPInv_Invoice $invoice The invoice to add the comment to.
-	 * @param string $note The note content.
-	 * @param string $note_author The name of the author of the note.
-	 * @param bool $for_customer Whether or not this comment is meant to be sent to the customer.
-	 * @return int|false The new note's ID on success, false on failure.
-	 */
-	function add_invoice_note( $invoice, $note, $note_author, $author_email, $for_customer = false ){
-
-		do_action( 'wpinv_pre_insert_invoice_note', $invoice->get_id(), $note, $for_customer );
-
-		/**
-		 * Insert the comment.
-		 */
-		$note_id = wp_insert_comment(
-			wp_filter_comment(
-				array(
-					'comment_post_ID'      => $invoice->get_id(),
-					'comment_content'      => $note,
-					'comment_agent'        => 'Invoicing',
-					'user_id'              => get_current_user_id(),
-					'comment_author'       => $note_author,
-					'comment_author_IP'    => wpinv_get_ip(),
-					'comment_author_email' => $author_email,
-					'comment_author_url'   => $invoice->get_view_url(),
-					'comment_type'         => 'wpinv_note',
-				)
-			)
-		);
-
-		do_action( 'wpinv_insert_payment_note', $note_id, $invoice->get_id(), $note, $for_customer );
-
-		// Are we notifying the customer?
-		if ( empty( $note_id ) || empty( $for_customer ) ) {
-			return $note_id;
-		}
-
-		add_comment_meta( $note_id, '_wpi_customer_note', 1 );
-		do_action( 'wpinv_new_customer_note', array( 'invoice_id' => $invoice->get_id(), 'user_note' => $note ) );
-		do_action( 'getpaid_new_customer_note', $invoice, $note );
-		return $note_id;
-	}
+                    ARRAY_A
+                );
+
+                $approved = array(
+                    '0'            => 'moderated',
+                    '1'            => 'approved',
+                    'spam'         => 'spam',
+                    'trash'        => 'trash',
+                    'post-trashed' => 'post-trashed',
+                );
+
+                foreach ( (array) $count as $row ) {
+                    // Don't count post-trashed toward totals.
+                    if ( ! in_array( $row['comment_approved'], array( 'post-trashed', 'trash', 'spam' ), true ) ) {
+                        $stats['all']            += $row['num_comments'];
+                        $stats['total_comments'] += $row['num_comments'];
+                    } elseif ( ! in_array( $row['comment_approved'], array( 'post-trashed', 'trash' ), true ) ) {
+                        $stats['total_comments'] += $row['num_comments'];
+                    }
+                    if ( isset( $approved[ $row['comment_approved'] ] ) ) {
+                        $stats[ $approved[ $row['comment_approved'] ] ] = $row['num_comments'];
+                    }
+                }
+
+                foreach ( $approved as $key ) {
+                    if ( empty( $stats[ $key ] ) ) {
+                        $stats[ $key ] = 0;
+                    }
+                }
+
+                $stats = (object) $stats;
+                set_transient( 'getpaid_count_comments', $stats );
+            }
+
+        }
+
+        return $stats;
+    }
+
+    /**
+     * Returns an array of invoice notes.
+     *
+     * @param int $invoice_id The invoice ID whose notes to retrieve.
+     * @param string $type Optional. Pass in customer to only return customer notes.
+     * @return WP_Comment[]
+     */
+    public function get_invoice_notes( $invoice_id = 0, $type = 'all' ) {
+
+        // Default comment args.
+        $args = array(
+            'post_id'   => $invoice_id,
+            'orderby'   => 'comment_ID',
+            'order'     => 'ASC',
+        );
+
+        // Maybe only show customer comments.
+        if ( $type == 'customer' ) {
+            $args['meta_key']   = '_wpi_customer_note';
+            $args['meta_value'] = 1;
+        }
+
+        $args = apply_filters( 'wpinv_invoice_notes_args', $args, $this, $invoice_id, $type );
+
+        return get_comments( $args );
+    }
+
+    /**
+     * Saves an invoice comment.
+     * 
+     * @param WPInv_Invoice $invoice The invoice to add the comment to.
+     * @param string $note The note content.
+     * @param string $note_author The name of the author of the note.
+     * @param bool $for_customer Whether or not this comment is meant to be sent to the customer.
+     * @return int|false The new note's ID on success, false on failure.
+     */
+    function add_invoice_note( $invoice, $note, $note_author, $author_email, $for_customer = false ){
+
+        do_action( 'wpinv_pre_insert_invoice_note', $invoice->get_id(), $note, $for_customer );
+
+        /**
+         * Insert the comment.
+         */
+        $note_id = wp_insert_comment(
+            wp_filter_comment(
+                array(
+                    'comment_post_ID'      => $invoice->get_id(),
+                    'comment_content'      => $note,
+                    'comment_agent'        => 'Invoicing',
+                    'user_id'              => get_current_user_id(),
+                    'comment_author'       => $note_author,
+                    'comment_author_IP'    => wpinv_get_ip(),
+                    'comment_author_email' => $author_email,
+                    'comment_author_url'   => $invoice->get_view_url(),
+                    'comment_type'         => 'wpinv_note',
+                )
+            )
+        );
+
+        do_action( 'wpinv_insert_payment_note', $note_id, $invoice->get_id(), $note, $for_customer );
+
+        // Are we notifying the customer?
+        if ( empty( $note_id ) || empty( $for_customer ) ) {
+            return $note_id;
+        }
+
+        add_comment_meta( $note_id, '_wpi_customer_note', 1 );
+        do_action( 'wpinv_new_customer_note', array( 'invoice_id' => $invoice->get_id(), 'user_note' => $note ) );
+        do_action( 'getpaid_new_customer_note', $invoice, $note );
+        return $note_id;
+    }
 
 }