AyeCode / invoicing

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

Indentation +479 added lines, -479 removed lines

@@ -5,7 +5,7 @@ 
  *
  */
 if ( ! defined( 'ABSPATH' ) ) {
-	exit;
+    exit;
 }
 
 /**
@@ -15,544 +15,544 @@ 
  */
 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_company_id',
-		'wpinv_shipping',
-		'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',
-		'_wpinv_company_id'        => 'company_id',
-		'wpinv_shipping'           => 'shipping',
-	);
-
-	/**
-	 * 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_company_id',
+        'wpinv_shipping',
+        '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',
+        '_wpinv_company_id'        => 'company_id',
+        'wpinv_shipping'           => 'shipping',
+    );
+
+    /**
+     * 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/payments/class-getpaid-checkout.php

Indentation +301 added lines, -301 removed lines

@@ -12,184 +12,184 @@ 
  */
 class GetPaid_Checkout {
 
-	/**
-	 * @var GetPaid_Payment_Form_Submission
-	 */
-	protected $payment_form_submission;
-
-	/**
-	 * Class constructor.
-	 * 
-	 * @param GetPaid_Payment_Form_Submission $submission
-	 */
-	public function __construct( $submission ) {
-		$this->payment_form_submission = $submission;
-	}
-
-	/**
-	 * Processes the checkout.
-	 *
-	 */
-	public function process_checkout() {
-
-		// Validate the submission.
-		$this->validate_submission();
-
-		// Prepare the invoice.
-		$items      = $this->get_submission_items();
-		$invoice    = $this->get_submission_invoice();
-		$invoice    = $this->process_submission_invoice( $invoice, $items );
-		$prepared   = $this->prepare_submission_data_for_saving();
-
-		$this->prepare_billing_info( $invoice );
-
-		$shipping   = $this->prepare_shipping_info( $invoice );
-
-		// Save the invoice.
-		$invoice->set_is_viewed( true );
-		$invoice->recalculate_total();
+    /**
+     * @var GetPaid_Payment_Form_Submission
+     */
+    protected $payment_form_submission;
+
+    /**
+     * Class constructor.
+     * 
+     * @param GetPaid_Payment_Form_Submission $submission
+     */
+    public function __construct( $submission ) {
+        $this->payment_form_submission = $submission;
+    }
+
+    /**
+     * Processes the checkout.
+     *
+     */
+    public function process_checkout() {
+
+        // Validate the submission.
+        $this->validate_submission();
+
+        // Prepare the invoice.
+        $items      = $this->get_submission_items();
+        $invoice    = $this->get_submission_invoice();
+        $invoice    = $this->process_submission_invoice( $invoice, $items );
+        $prepared   = $this->prepare_submission_data_for_saving();
+
+        $this->prepare_billing_info( $invoice );
+
+        $shipping   = $this->prepare_shipping_info( $invoice );
+
+        // Save the invoice.
+        $invoice->set_is_viewed( true );
+        $invoice->recalculate_total();
         $invoice->save();
 
-		do_action( 'getpaid_checkout_invoice_updated', $invoice );
+        do_action( 'getpaid_checkout_invoice_updated', $invoice );
 
-		// Send to the gateway.
-		$this->post_process_submission( $invoice, $prepared, $shipping );
-	}
+        // Send to the gateway.
+        $this->post_process_submission( $invoice, $prepared, $shipping );
+    }
 
-	/**
-	 * Validates the submission.
-	 *
-	 */
-	protected function validate_submission() {
+    /**
+     * Validates the submission.
+     *
+     */
+    protected function validate_submission() {
 
-		$submission = $this->payment_form_submission;
-		$data       = $submission->get_data();
+        $submission = $this->payment_form_submission;
+        $data       = $submission->get_data();
 
-		// Do we have an error?
+        // Do we have an error?
         if ( ! empty( $submission->last_error ) ) {
-			wp_send_json_error( $submission->last_error );
+            wp_send_json_error( $submission->last_error );
         }
 
-		// We need a billing email.
+        // We need a billing email.
         if ( ! $submission->has_billing_email() ) {
             wp_send_json_error( __( 'Provide a valid billing email.', 'invoicing' ) );
-		}
+        }
 
-		// Non-recurring gateways should not be allowed to process recurring invoices.
-		if ( $submission->should_collect_payment_details() && $submission->has_recurring && ! wpinv_gateway_support_subscription( $data['wpi-gateway'] ) ) {
-			wp_send_json_error( __( 'The selected payment gateway does not support subscription payments.', 'invoicing' ) );
-		}
+        // Non-recurring gateways should not be allowed to process recurring invoices.
+        if ( $submission->should_collect_payment_details() && $submission->has_recurring && ! wpinv_gateway_support_subscription( $data['wpi-gateway'] ) ) {
+            wp_send_json_error( __( 'The selected payment gateway does not support subscription payments.', 'invoicing' ) );
+        }
 
-		// Ensure the gateway is active.
-		if ( $submission->should_collect_payment_details() && ! wpinv_is_gateway_active( $data['wpi-gateway'] ) ) {
-			wp_send_json_error( __( 'The selected payment gateway is not active', 'invoicing' ) );
-		}
+        // Ensure the gateway is active.
+        if ( $submission->should_collect_payment_details() && ! wpinv_is_gateway_active( $data['wpi-gateway'] ) ) {
+            wp_send_json_error( __( 'The selected payment gateway is not active', 'invoicing' ) );
+        }
 
-		// Clear any existing errors.
-		wpinv_clear_errors();
+        // Clear any existing errors.
+        wpinv_clear_errors();
 
-		// Allow themes and plugins to hook to errors
-		do_action( 'getpaid_checkout_error_checks', $submission );
+        // Allow themes and plugins to hook to errors
+        do_action( 'getpaid_checkout_error_checks', $submission );
 
-		// Do we have any errors?
+        // Do we have any errors?
         if ( wpinv_get_errors() ) {
             wp_send_json_error( getpaid_get_errors_html() );
-		}
+        }
 
-	}
+    }
 
-	/**
-	 * Retrieves submission items.
-	 *
-	 * @return GetPaid_Form_Item[]
-	 */
-	protected function get_submission_items() {
+    /**
+     * Retrieves submission items.
+     *
+     * @return GetPaid_Form_Item[]
+     */
+    protected function get_submission_items() {
 
-		$items = $this->payment_form_submission->get_items();
+        $items = $this->payment_form_submission->get_items();
 
         // Ensure that we have items.
         if ( empty( $items ) && ! $this->payment_form_submission->has_fees() ) {
             wp_send_json_error( __( 'Please provide at least one item or amount.', 'invoicing' ) );
-		}
-
-		return $items;
-	}
-
-	/**
-	 * Retrieves submission invoice.
-	 *
-	 * @return WPInv_Invoice
-	 */
-	protected function get_submission_invoice() {
-		$submission = $this->payment_form_submission;
-
-		if ( ! $submission->has_invoice() ) {
-			$invoice = new WPInv_Invoice();
-			$invoice->set_created_via( 'payment_form' );
-			return $invoice;
         }
 
-		$invoice = $submission->get_invoice();
+        return $items;
+    }
+
+    /**
+     * Retrieves submission invoice.
+     *
+     * @return WPInv_Invoice
+     */
+    protected function get_submission_invoice() {
+        $submission = $this->payment_form_submission;
+
+        if ( ! $submission->has_invoice() ) {
+            $invoice = new WPInv_Invoice();
+            $invoice->set_created_via( 'payment_form' );
+            return $invoice;
+        }
+
+        $invoice = $submission->get_invoice();
 
-		// Make sure that it is neither paid or refunded.
-		if ( $invoice->is_paid() || $invoice->is_refunded() ) {
-			wp_send_json_error( __( 'This invoice has already been paid for.', 'invoicing' ) );
-		}
+        // Make sure that it is neither paid or refunded.
+        if ( $invoice->is_paid() || $invoice->is_refunded() ) {
+            wp_send_json_error( __( 'This invoice has already been paid for.', 'invoicing' ) );
+        }
 
-		return $invoice;
-	}
+        return $invoice;
+    }
 
-	/**
-	 * Processes the submission invoice.
-	 *
-	 * @param WPInv_Invoice $invoice
-	 * @param GetPaid_Form_Item[] $items
-	 * @return WPInv_Invoice
-	 */
-	protected function process_submission_invoice( $invoice, $items ) {
+    /**
+     * Processes the submission invoice.
+     *
+     * @param WPInv_Invoice $invoice
+     * @param GetPaid_Form_Item[] $items
+     * @return WPInv_Invoice
+     */
+    protected function process_submission_invoice( $invoice, $items ) {
 
-		$submission = $this->payment_form_submission;
+        $submission = $this->payment_form_submission;
 
-		// Set-up the invoice details.
-		$invoice->set_email( sanitize_email( $submission->get_billing_email() ) );
-		$invoice->set_user_id( $this->get_submission_customer() );
-		$invoice->set_payment_form( absint( $submission->get_payment_form()->get_id() ) );
+        // Set-up the invoice details.
+        $invoice->set_email( sanitize_email( $submission->get_billing_email() ) );
+        $invoice->set_user_id( $this->get_submission_customer() );
+        $invoice->set_payment_form( absint( $submission->get_payment_form()->get_id() ) );
         $invoice->set_items( $items );
         $invoice->set_fees( $submission->get_fees() );
         $invoice->set_taxes( $submission->get_taxes() );
-		$invoice->set_discounts( $submission->get_discounts() );
-		$invoice->set_gateway( $submission->get_field( 'wpi-gateway' ) );
-		$invoice->set_currency( $submission->get_currency() );
+        $invoice->set_discounts( $submission->get_discounts() );
+        $invoice->set_gateway( $submission->get_field( 'wpi-gateway' ) );
+        $invoice->set_currency( $submission->get_currency() );
 
-		if ( $submission->has_shipping() ) {
-			$invoice->set_shipping( $submission->get_shipping() );
-		}
+        if ( $submission->has_shipping() ) {
+            $invoice->set_shipping( $submission->get_shipping() );
+        }
 
-		$address_confirmed = $submission->get_field( 'confirm-address' );
-		$invoice->set_address_confirmed( ! empty( $address_confirmed ) );
+        $address_confirmed = $submission->get_field( 'confirm-address' );
+        $invoice->set_address_confirmed( ! empty( $address_confirmed ) );
 
-		if ( $submission->has_discount_code() ) {
+        if ( $submission->has_discount_code() ) {
             $invoice->set_discount_code( $submission->get_discount_code() );
-		}
-
-		getpaid_maybe_add_default_address( $invoice );
-		return $invoice;
-	}
-
-	/**
-	 * Retrieves the submission's customer.
-	 *
-	 * @return int The customer id.
-	 */
-	protected function get_submission_customer() {
-		$submission = $this->payment_form_submission;
-
-		// If this is an existing invoice...
-		if ( $submission->has_invoice() ) {
-			return $submission->get_invoice()->get_user_id();
-		}
-
-		// (Maybe) create the user.
+        }
+
+        getpaid_maybe_add_default_address( $invoice );
+        return $invoice;
+    }
+
+    /**
+     * Retrieves the submission's customer.
+     *
+     * @return int The customer id.
+     */
+    protected function get_submission_customer() {
+        $submission = $this->payment_form_submission;
+
+        // If this is an existing invoice...
+        if ( $submission->has_invoice() ) {
+            return $submission->get_invoice()->get_user_id();
+        }
+
+        // (Maybe) create the user.
         $user = get_current_user_id();
 
         if ( empty( $user ) ) {
@@ -199,11 +199,11 @@ 
         if ( empty( $user ) ) {
             $user = wpinv_create_user( $submission->get_billing_email() );
 
-			// (Maybe) send new user notification.
-			$should_send_notification = wpinv_get_option( 'disable_new_user_emails' );
-			if ( ! empty( $user ) && is_numeric( $user ) && apply_filters( 'getpaid_send_new_user_notification', empty( $should_send_notification ), $user ) ) {
-				wp_send_new_user_notifications( $user, 'user' );
-			}
+            // (Maybe) send new user notification.
+            $should_send_notification = wpinv_get_option( 'disable_new_user_emails' );
+            if ( ! empty( $user ) && is_numeric( $user ) && apply_filters( 'getpaid_send_new_user_notification', empty( $should_send_notification ), $user ) ) {
+                wp_send_new_user_notifications( $user, 'user' );
+            }
 
         }
 
@@ -213,49 +213,49 @@ 
 
         if ( is_numeric( $user ) ) {
             return $user;
-		}
+        }
 
-		return $user->ID;
+        return $user->ID;
 
-	}
+    }
 
-	/**
+    /**
      * Prepares submission data for saving to the database.
      *
-	 * @return array
+     * @return array
      */
     public function prepare_submission_data_for_saving() {
 
-		$submission = $this->payment_form_submission;
+        $submission = $this->payment_form_submission;
 
-		// Prepared submission details.
+        // Prepared submission details.
         $prepared = array(
-			'all'  => array(),
-			'meta' => array(),
-		);
+            'all'  => array(),
+            'meta' => array(),
+        );
 
         // Raw submission details.
-		$data     = $submission->get_data();
+        $data     = $submission->get_data();
 
-		// Loop through the submitted details.
+        // Loop through the submitted details.
         foreach ( $submission->get_payment_form()->get_elements() as $field ) {
 
-			// Skip premade fields.
+            // Skip premade fields.
             if ( ! empty( $field['premade'] ) ) {
                 continue;
             }
 
-			// Ensure address is provided.
-			if ( $field['type'] == 'address' ) {
+            // Ensure address is provided.
+            if ( $field['type'] == 'address' ) {
                 $address_type = isset( $field['address_type'] ) && 'shipping' === $field['address_type'] ? 'shipping' : 'billing';
 
-				foreach ( $field['fields'] as $address_field ) {
+                foreach ( $field['fields'] as $address_field ) {
 
-					if ( ! empty( $address_field['visible'] ) && ! empty( $address_field['required'] ) && '' === trim( $_POST[ $address_type ][ $address_field['name'] ] ) ) {
-						wp_send_json_error( __( 'Please fill all required fields.', 'invoicing' ) );
-					}
+                    if ( ! empty( $address_field['visible'] ) && ! empty( $address_field['required'] ) && '' === trim( $_POST[ $address_type ][ $address_field['name'] ] ) ) {
+                        wp_send_json_error( __( 'Please fill all required fields.', 'invoicing' ) );
+                    }
 
-				}
+                }
 
             }
 
@@ -267,31 +267,31 @@ 
             // Handle misc fields.
             if ( isset( $data[ $field['id'] ] ) ) {
 
-				// Uploads.
-				if ( $field['type'] == 'file_upload' ) {
-					$max_file_num = empty( $field['max_file_num'] ) ? 1 : absint( $field['max_file_num'] );
+                // Uploads.
+                if ( $field['type'] == 'file_upload' ) {
+                    $max_file_num = empty( $field['max_file_num'] ) ? 1 : absint( $field['max_file_num'] );
 
-					if ( count( $data[ $field['id'] ] ) > $max_file_num ) {
-						wp_send_json_error( __( 'Maximum number of allowed files exceeded.', 'invoicing' ) );
-					}
+                    if ( count( $data[ $field['id'] ] ) > $max_file_num ) {
+                        wp_send_json_error( __( 'Maximum number of allowed files exceeded.', 'invoicing' ) );
+                    }
 
-					$value = array();
+                    $value = array();
 
-					foreach ( $data[ $field['id'] ] as $url => $name ) {
-						$value[] = sprintf(
-							'<a href="%s" target="_blank">%s</a>',
-							esc_url_raw( $url ),
-							esc_html( $name )
-						);
-					}
+                    foreach ( $data[ $field['id'] ] as $url => $name ) {
+                        $value[] = sprintf(
+                            '<a href="%s" target="_blank">%s</a>',
+                            esc_url_raw( $url ),
+                            esc_html( $name )
+                        );
+                    }
 
-					$value = implode( ' | ', $value );
+                    $value = implode( ' | ', $value );
 
-				} else if ( $field['type'] == 'checkbox' ) {
-					$value = isset( $data[ $field['id'] ] ) ? __( 'Yes', 'invoicing' ) : __( 'No', 'invoicing' );
-				} else {
-					$value = wp_kses_post( $data[ $field['id'] ] );
-				}
+                } else if ( $field['type'] == 'checkbox' ) {
+                    $value = isset( $data[ $field['id'] ] ) ? __( 'Yes', 'invoicing' ) : __( 'No', 'invoicing' );
+                } else {
+                    $value = wp_kses_post( $data[ $field['id'] ] );
+                }
 
                 $label = $field['id'];
 
@@ -299,190 +299,190 @@ 
                     $label = $field['label'];
                 }
 
-				if ( ! empty( $field['add_meta'] ) ) {
-					$prepared['meta'][ wpinv_clean( $label ) ] = wp_kses_post_deep( $value );
-				}
-				$prepared['all'][ wpinv_clean( $label ) ] = wp_kses_post_deep( $value );
+                if ( ! empty( $field['add_meta'] ) ) {
+                    $prepared['meta'][ wpinv_clean( $label ) ] = wp_kses_post_deep( $value );
+                }
+                $prepared['all'][ wpinv_clean( $label ) ] = wp_kses_post_deep( $value );
 
             }
 
-		}
+        }
 
-		return $prepared;
+        return $prepared;
 
-	}
+    }
 
-	/**
+    /**
      * Retrieves address details.
      *
-	 * @return array
-	 * @param WPInv_Invoice $invoice
-	 * @param string $type
+     * @return array
+     * @param WPInv_Invoice $invoice
+     * @param string $type
      */
     public function prepare_address_details( $invoice, $type = 'billing' ) {
 
-		$data     = $this->payment_form_submission->get_data();
-		$type     = sanitize_key( $type );
-		$address  = array();
-		$prepared = array();
+        $data     = $this->payment_form_submission->get_data();
+        $type     = sanitize_key( $type );
+        $address  = array();
+        $prepared = array();
 
-		if ( ! empty( $data[ $type ] ) ) {
-			$address = $data[ $type ];
-		}
+        if ( ! empty( $data[ $type ] ) ) {
+            $address = $data[ $type ];
+        }
 
-		// Clean address details.
-		foreach ( $address as $key => $value ) {
-			$key             = sanitize_key( $key );
-			$key             = str_replace( 'wpinv_', '', $key );
-			$value           = wpinv_clean( $value );
-			$prepared[ $key] = apply_filters( "getpaid_checkout_{$type}_address_$key", $value, $this->payment_form_submission, $invoice );
-		}
+        // Clean address details.
+        foreach ( $address as $key => $value ) {
+            $key             = sanitize_key( $key );
+            $key             = str_replace( 'wpinv_', '', $key );
+            $value           = wpinv_clean( $value );
+            $prepared[ $key] = apply_filters( "getpaid_checkout_{$type}_address_$key", $value, $this->payment_form_submission, $invoice );
+        }
 
-		// Filter address details.
-		$prepared = apply_filters( "getpaid_checkout_{$type}_address", $prepared, $this->payment_form_submission, $invoice );
+        // Filter address details.
+        $prepared = apply_filters( "getpaid_checkout_{$type}_address", $prepared, $this->payment_form_submission, $invoice );
 
-		// Remove non-whitelisted values.
-		return array_filter( $prepared, 'getpaid_is_address_field_whitelisted', ARRAY_FILTER_USE_KEY );
+        // Remove non-whitelisted values.
+        return array_filter( $prepared, 'getpaid_is_address_field_whitelisted', ARRAY_FILTER_USE_KEY );
 
-	}
+    }
 
-	/**
+    /**
      * Prepares the billing details.
      *
-	 * @return array
-	 * @param WPInv_Invoice $invoice
+     * @return array
+     * @param WPInv_Invoice $invoice
      */
     protected function prepare_billing_info( &$invoice ) {
 
-		$billing_address = $this->prepare_address_details( $invoice, 'billing' );
+        $billing_address = $this->prepare_address_details( $invoice, 'billing' );
 
-		// Update the invoice with the billing details.
-		$invoice->set_props( $billing_address );
+        // Update the invoice with the billing details.
+        $invoice->set_props( $billing_address );
 
-	}
+    }
 
-	/**
+    /**
      * Prepares the shipping details.
      *
-	 * @return array
-	 * @param WPInv_Invoice $invoice
+     * @return array
+     * @param WPInv_Invoice $invoice
      */
     protected function prepare_shipping_info( $invoice ) {
 
-		$data = $this->payment_form_submission->get_data();
+        $data = $this->payment_form_submission->get_data();
 
-		if ( empty( $data['same-shipping-address'] ) ) {
-			return $this->prepare_address_details( $invoice, 'shipping' );
-		}
+        if ( empty( $data['same-shipping-address'] ) ) {
+            return $this->prepare_address_details( $invoice, 'shipping' );
+        }
 
-		return $this->prepare_address_details( $invoice, 'billing' );
+        return $this->prepare_address_details( $invoice, 'billing' );
 
-	}
+    }
 
-	/**
-	 * Confirms the submission is valid and send users to the gateway.
-	 *
-	 * @param WPInv_Invoice $invoice
-	 * @param array $prepared_payment_form_data
-	 * @param array $shipping
-	 */
-	protected function post_process_submission( $invoice, $prepared_payment_form_data, $shipping ) {
+    /**
+     * Confirms the submission is valid and send users to the gateway.
+     *
+     * @param WPInv_Invoice $invoice
+     * @param array $prepared_payment_form_data
+     * @param array $shipping
+     */
+    protected function post_process_submission( $invoice, $prepared_payment_form_data, $shipping ) {
 
-		// Ensure the invoice exists.
+        // Ensure the invoice exists.
         if ( ! $invoice->exists() ) {
             wp_send_json_error( __( 'An error occured while saving your invoice. Please try again.', 'invoicing' ) );
         }
 
-		// Save payment form data.
-		$prepared_payment_form_data = apply_filters( 'getpaid_prepared_payment_form_data', $prepared_payment_form_data, $invoice );
+        // Save payment form data.
+        $prepared_payment_form_data = apply_filters( 'getpaid_prepared_payment_form_data', $prepared_payment_form_data, $invoice );
         delete_post_meta( $invoice->get_id(), 'payment_form_data' );
-		delete_post_meta( $invoice->get_id(), 'additional_meta_data' );
-		if ( ! empty( $prepared_payment_form_data ) ) {
+        delete_post_meta( $invoice->get_id(), 'additional_meta_data' );
+        if ( ! empty( $prepared_payment_form_data ) ) {
 
-			if ( ! empty( $prepared_payment_form_data['all'] ) ) {
-				update_post_meta( $invoice->get_id(), 'payment_form_data', $prepared_payment_form_data['all'] );
-			}
+            if ( ! empty( $prepared_payment_form_data['all'] ) ) {
+                update_post_meta( $invoice->get_id(), 'payment_form_data', $prepared_payment_form_data['all'] );
+            }
 
-			if ( ! empty( $prepared_payment_form_data['meta'] ) ) {
-				update_post_meta( $invoice->get_id(), 'additional_meta_data', $prepared_payment_form_data['meta'] );
-			}
+            if ( ! empty( $prepared_payment_form_data['meta'] ) ) {
+                update_post_meta( $invoice->get_id(), 'additional_meta_data', $prepared_payment_form_data['meta'] );
+            }
 
-		}
+        }
 
-		// Save payment form data.
-		$shipping = apply_filters( 'getpaid_checkout_shipping_details', $shipping, $this->payment_form_submission );
+        // Save payment form data.
+        $shipping = apply_filters( 'getpaid_checkout_shipping_details', $shipping, $this->payment_form_submission );
         if ( ! empty( $shipping ) ) {
             update_post_meta( $invoice->get_id(), 'shipping_address', $shipping );
-		}
+        }
 
-		// Backwards compatibility.
+        // Backwards compatibility.
         add_filter( 'wp_redirect', array( $this, 'send_redirect_response' ) );
 
-		$this->process_payment( $invoice );
+        $this->process_payment( $invoice );
 
         // If we are here, there was an error.
-		wpinv_send_back_to_checkout( $invoice );
+        wpinv_send_back_to_checkout( $invoice );
 
-	}
+    }
 
-	/**
-	 * Processes the actual payment.
-	 *
-	 * @param WPInv_Invoice $invoice
-	 */
-	protected function process_payment( $invoice ) {
+    /**
+     * Processes the actual payment.
+     *
+     * @param WPInv_Invoice $invoice
+     */
+    protected function process_payment( $invoice ) {
 
-		// Clear any checkout errors.
-		wpinv_clear_errors();
+        // Clear any checkout errors.
+        wpinv_clear_errors();
 
-		// No need to send free invoices to the gateway.
-		if ( $invoice->is_free() ) {
-			$this->process_free_payment( $invoice );
-		}
+        // No need to send free invoices to the gateway.
+        if ( $invoice->is_free() ) {
+            $this->process_free_payment( $invoice );
+        }
 
-		$submission = $this->payment_form_submission;
+        $submission = $this->payment_form_submission;
 
-		// Fires before sending to the gateway.
-		do_action( 'getpaid_checkout_before_gateway', $invoice, $submission );
+        // Fires before sending to the gateway.
+        do_action( 'getpaid_checkout_before_gateway', $invoice, $submission );
 
-		// Allow the sumission data to be modified before it is sent to the gateway.
-		$submission_data    = $submission->get_data();
-		$submission_gateway = apply_filters( 'getpaid_gateway_submission_gateway', $invoice->get_gateway(), $submission, $invoice );
-		$submission_data    = apply_filters( 'getpaid_gateway_submission_data', $submission_data, $submission, $invoice );
+        // Allow the sumission data to be modified before it is sent to the gateway.
+        $submission_data    = $submission->get_data();
+        $submission_gateway = apply_filters( 'getpaid_gateway_submission_gateway', $invoice->get_gateway(), $submission, $invoice );
+        $submission_data    = apply_filters( 'getpaid_gateway_submission_data', $submission_data, $submission, $invoice );
 
-		// Validate the currency.
-		if ( ! apply_filters( "getpaid_gateway_{$submission_gateway}_is_valid_for_currency", true, $invoice->get_currency() ) ) {
-			wpinv_set_error( 'invalid_currency', __( 'The chosen payment gateway does not support this currency', 'invoicing' ) );
-		}
+        // Validate the currency.
+        if ( ! apply_filters( "getpaid_gateway_{$submission_gateway}_is_valid_for_currency", true, $invoice->get_currency() ) ) {
+            wpinv_set_error( 'invalid_currency', __( 'The chosen payment gateway does not support this currency', 'invoicing' ) );
+        }
 
-		// Check to see if we have any errors.
-		if ( wpinv_get_errors() ) {
-			wpinv_send_back_to_checkout( $invoice );
-		}
+        // Check to see if we have any errors.
+        if ( wpinv_get_errors() ) {
+            wpinv_send_back_to_checkout( $invoice );
+        }
 
-		// Send info to the gateway for payment processing
-		do_action( "getpaid_gateway_$submission_gateway", $invoice, $submission_data, $submission );
+        // Send info to the gateway for payment processing
+        do_action( "getpaid_gateway_$submission_gateway", $invoice, $submission_data, $submission );
 
-		// Backwards compatibility.
-		wpinv_send_to_gateway( $submission_gateway, $invoice );
+        // Backwards compatibility.
+        wpinv_send_to_gateway( $submission_gateway, $invoice );
 
-	}
+    }
 
-	/**
-	 * Marks the invoice as paid in case the checkout is free.
-	 *
-	 * @param WPInv_Invoice $invoice
-	 */
-	protected function process_free_payment( $invoice ) {
+    /**
+     * Marks the invoice as paid in case the checkout is free.
+     *
+     * @param WPInv_Invoice $invoice
+     */
+    protected function process_free_payment( $invoice ) {
 
-		$invoice->set_gateway( 'none' );
-		$invoice->add_note( __( "This is a free invoice and won't be sent to the payment gateway", 'invoicing' ), false, false, true );
-		$invoice->mark_paid();
-		wpinv_send_to_success_page( array( 'invoice_key' => $invoice->get_key() ) );
+        $invoice->set_gateway( 'none' );
+        $invoice->add_note( __( "This is a free invoice and won't be sent to the payment gateway", 'invoicing' ), false, false, true );
+        $invoice->mark_paid();
+        wpinv_send_to_success_page( array( 'invoice_key' => $invoice->get_key() ) );
 
-	}
+    }
 
-	/**
+    /**
      * Sends a redrect response to payment details.
      *
      */

includes/gateways/class-getpaid-paypal-gateway-ipn-handler.php

Indentation +390 added lines, -390 removed lines

@@ -12,474 +12,474 @@
  */
 class GetPaid_Paypal_Gateway_IPN_Handler {
 
-	/**
-	 * Payment method id.
-	 *
-	 * @var string
-	 */
-	protected $id = 'paypal';
-
-	/**
-	 * Payment method object.
-	 *
-	 * @var GetPaid_Paypal_Gateway
-	 */
-	protected $gateway;
-
-	/**
-	 * Class constructor.
-	 *
-	 * @param GetPaid_Paypal_Gateway $gateway
-	 */
-	public function __construct( $gateway ) {
-		$this->gateway = $gateway;
-		$this->verify_ipn();
-	}
-
-	/**
-	 * Processes ipns and marks payments as complete.
-	 *
-	 * @return void
-	 */
-	public function verify_ipn() {
-
-		wpinv_error_log( 'GetPaid PayPal IPN Handler', false );
-
-		// Validate the IPN.
-		if ( empty( $_POST ) || ! $this->validate_ipn() ) {
-			wp_die( 'PayPal IPN Request Failure', 500 );
-		}
-
-		// Process the IPN.
-		$posted  = wp_kses_post_deep( wp_unslash( $_POST ) );
-		$invoice = $this->get_ipn_invoice( $posted );
-
-		// Abort if it was not paid by our gateway.
-		if ( $this->id != $invoice->get_gateway() ) {
-			wpinv_error_log( 'Aborting, Invoice was not paid via PayPal', false );
-			wp_die( 'Invoice not paid via PayPal', 200 );
-		}
-
-		$posted['payment_status'] = isset( $posted['payment_status'] ) ? sanitize_key( strtolower( $posted['payment_status'] ) ) : '';
-		$posted['txn_type']       = sanitize_key( strtolower( $posted['txn_type'] ) );
-
-		wpinv_error_log( 'Payment status:' . $posted['payment_status'], false );
-		wpinv_error_log( 'IPN Type:' . $posted['txn_type'], false );
-
-		if ( method_exists( $this, 'ipn_txn_' . $posted['txn_type'] ) ) {
-			call_user_func( array( $this, 'ipn_txn_' . $posted['txn_type'] ), $invoice, $posted );
-			wpinv_error_log( 'Done processing IPN', false );
-			wp_die( 'Processed', 200 );
-		}
-
-		wpinv_error_log( 'Aborting, Unsupported IPN type:' . $posted['txn_type'], false );
-		wp_die( 'Unsupported IPN type', 200 );
-
-	}
-
-	/**
-	 * Retrieves IPN Invoice.
-	 *
-	 * @param array $posted
-	 * @return WPInv_Invoice
-	 */
-	protected function get_ipn_invoice( $posted ) {
-
-		wpinv_error_log( 'Retrieving PayPal IPN Response Invoice', false );
-
-		if ( ! empty( $posted['custom'] ) ) {
-			$invoice = new WPInv_Invoice( $posted['custom'] );
-
-			if ( $invoice->exists() ) {
-				wpinv_error_log( 'Found invoice #' . $invoice->get_number(), false );
-				return $invoice;
-			}
-
-		}
-
-		wpinv_error_log( 'Could not retrieve the associated invoice.', false );
-		wp_die( 'Could not retrieve the associated invoice.', 200 );
-	}
-
-	/**
-	 * Check PayPal IPN validity.
-	 */
-	protected function validate_ipn() {
-
-		wpinv_error_log( 'Validating PayPal IPN response', false );
-
-		// Retrieve the associated invoice.
-		$posted  = wp_kses_post_deep( wp_unslash( $_POST ) );
-		$invoice = $this->get_ipn_invoice( $posted );
-
-		if ( $this->gateway->is_sandbox( $invoice ) ) {
-			wpinv_error_log( $posted, 'Invoice was processed in sandbox hence logging the posted data', false );
-		}
-
-		// Validate the IPN.
-		$posted['cmd'] = '_notify-validate';
-
-		// Send back post vars to paypal.
-		$params = array(
-			'body'        => $posted,
-			'timeout'     => 60,
-			'httpversion' => '1.1',
-			'compress'    => false,
-			'decompress'  => false,
-			'user-agent'  => 'GetPaid/' . WPINV_VERSION,
-		);
-
-		// Post back to get a response.
-		$response = wp_safe_remote_post( $this->gateway->is_sandbox( $invoice ) ? 'https://www.sandbox.paypal.com/cgi-bin/webscr' : 'https://www.paypal.com/cgi-bin/webscr', $params );
-
-		// Check to see if the request was valid.
-		if ( ! is_wp_error( $response ) && $response['response']['code'] < 300 && strstr( $response['body'], 'VERIFIED' ) ) {
-			wpinv_error_log( 'Received valid response from PayPal IPN: ' . $response['body'], false );
-			return true;
-		}
-
-		if ( is_wp_error( $response ) ) {
-			wpinv_error_log( $response->get_error_message(), 'Received invalid response from PayPal IPN' );
-			return false;
-		}
+    /**
+     * Payment method id.
+     *
+     * @var string
+     */
+    protected $id = 'paypal';
+
+    /**
+     * Payment method object.
+     *
+     * @var GetPaid_Paypal_Gateway
+     */
+    protected $gateway;
+
+    /**
+     * Class constructor.
+     *
+     * @param GetPaid_Paypal_Gateway $gateway
+     */
+    public function __construct( $gateway ) {
+        $this->gateway = $gateway;
+        $this->verify_ipn();
+    }
+
+    /**
+     * Processes ipns and marks payments as complete.
+     *
+     * @return void
+     */
+    public function verify_ipn() {
+
+        wpinv_error_log( 'GetPaid PayPal IPN Handler', false );
+
+        // Validate the IPN.
+        if ( empty( $_POST ) || ! $this->validate_ipn() ) {
+            wp_die( 'PayPal IPN Request Failure', 500 );
+        }
+
+        // Process the IPN.
+        $posted  = wp_kses_post_deep( wp_unslash( $_POST ) );
+        $invoice = $this->get_ipn_invoice( $posted );
+
+        // Abort if it was not paid by our gateway.
+        if ( $this->id != $invoice->get_gateway() ) {
+            wpinv_error_log( 'Aborting, Invoice was not paid via PayPal', false );
+            wp_die( 'Invoice not paid via PayPal', 200 );
+        }
+
+        $posted['payment_status'] = isset( $posted['payment_status'] ) ? sanitize_key( strtolower( $posted['payment_status'] ) ) : '';
+        $posted['txn_type']       = sanitize_key( strtolower( $posted['txn_type'] ) );
+
+        wpinv_error_log( 'Payment status:' . $posted['payment_status'], false );
+        wpinv_error_log( 'IPN Type:' . $posted['txn_type'], false );
+
+        if ( method_exists( $this, 'ipn_txn_' . $posted['txn_type'] ) ) {
+            call_user_func( array( $this, 'ipn_txn_' . $posted['txn_type'] ), $invoice, $posted );
+            wpinv_error_log( 'Done processing IPN', false );
+            wp_die( 'Processed', 200 );
+        }
+
+        wpinv_error_log( 'Aborting, Unsupported IPN type:' . $posted['txn_type'], false );
+        wp_die( 'Unsupported IPN type', 200 );
+
+    }
+
+    /**
+     * Retrieves IPN Invoice.
+     *
+     * @param array $posted
+     * @return WPInv_Invoice
+     */
+    protected function get_ipn_invoice( $posted ) {
+
+        wpinv_error_log( 'Retrieving PayPal IPN Response Invoice', false );
+
+        if ( ! empty( $posted['custom'] ) ) {
+            $invoice = new WPInv_Invoice( $posted['custom'] );
+
+            if ( $invoice->exists() ) {
+                wpinv_error_log( 'Found invoice #' . $invoice->get_number(), false );
+                return $invoice;
+            }
+
+        }
+
+        wpinv_error_log( 'Could not retrieve the associated invoice.', false );
+        wp_die( 'Could not retrieve the associated invoice.', 200 );
+    }
+
+    /**
+     * Check PayPal IPN validity.
+     */
+    protected function validate_ipn() {
+
+        wpinv_error_log( 'Validating PayPal IPN response', false );
+
+        // Retrieve the associated invoice.
+        $posted  = wp_kses_post_deep( wp_unslash( $_POST ) );
+        $invoice = $this->get_ipn_invoice( $posted );
+
+        if ( $this->gateway->is_sandbox( $invoice ) ) {
+            wpinv_error_log( $posted, 'Invoice was processed in sandbox hence logging the posted data', false );
+        }
+
+        // Validate the IPN.
+        $posted['cmd'] = '_notify-validate';
+
+        // Send back post vars to paypal.
+        $params = array(
+            'body'        => $posted,
+            'timeout'     => 60,
+            'httpversion' => '1.1',
+            'compress'    => false,
+            'decompress'  => false,
+            'user-agent'  => 'GetPaid/' . WPINV_VERSION,
+        );
+
+        // Post back to get a response.
+        $response = wp_safe_remote_post( $this->gateway->is_sandbox( $invoice ) ? 'https://www.sandbox.paypal.com/cgi-bin/webscr' : 'https://www.paypal.com/cgi-bin/webscr', $params );
+
+        // Check to see if the request was valid.
+        if ( ! is_wp_error( $response ) && $response['response']['code'] < 300 && strstr( $response['body'], 'VERIFIED' ) ) {
+            wpinv_error_log( 'Received valid response from PayPal IPN: ' . $response['body'], false );
+            return true;
+        }
+
+        if ( is_wp_error( $response ) ) {
+            wpinv_error_log( $response->get_error_message(), 'Received invalid response from PayPal IPN' );
+            return false;
+        }
 
-		wpinv_error_log( $response['body'], 'Received invalid response from PayPal IPN' );
-		return false;
-
-	}
+        wpinv_error_log( $response['body'], 'Received invalid response from PayPal IPN' );
+        return false;
+
+    }
 
-	/**
-	 * Check currency from IPN matches the invoice.
-	 *
-	 * @param WPInv_Invoice $invoice          Invoice object.
-	 * @param string   $currency currency to validate.
-	 */
-	protected function validate_ipn_currency( $invoice, $currency ) {
+    /**
+     * Check currency from IPN matches the invoice.
+     *
+     * @param WPInv_Invoice $invoice          Invoice object.
+     * @param string   $currency currency to validate.
+     */
+    protected function validate_ipn_currency( $invoice, $currency ) {
 
-		if ( strtolower( $invoice->get_currency() ) !== strtolower( $currency ) ) {
+        if ( strtolower( $invoice->get_currency() ) !== strtolower( $currency ) ) {
 
-			/* translators: %s: currency code. */
-			$invoice->update_status( 'wpi-processing', sprintf( __( 'Validation error: PayPal currencies do not match (code %s).', 'invoicing' ), $currency ) );
+            /* translators: %s: currency code. */
+            $invoice->update_status( 'wpi-processing', sprintf( __( 'Validation error: PayPal currencies do not match (code %s).', 'invoicing' ), $currency ) );
 
-			wpinv_error_log( "Currencies do not match: {$currency} instead of {$invoice->get_currency()}", 'IPN Error', __FILE__, __LINE__, true );
-		}
+            wpinv_error_log( "Currencies do not match: {$currency} instead of {$invoice->get_currency()}", 'IPN Error', __FILE__, __LINE__, true );
+        }
 
-		wpinv_error_log( $currency, 'Validated IPN Currency', false );
-	}
+        wpinv_error_log( $currency, 'Validated IPN Currency', false );
+    }
 
-	/**
-	 * Check payment amount from IPN matches the invoice.
-	 *
-	 * @param WPInv_Invoice $invoice          Invoice object.
-	 * @param float   $amount amount to validate.
-	 */
-	protected function validate_ipn_amount( $invoice, $amount ) {
-		if ( number_format( $invoice->get_total(), 2, '.', '' ) !== number_format( $amount, 2, '.', '' ) ) {
+    /**
+     * Check payment amount from IPN matches the invoice.
+     *
+     * @param WPInv_Invoice $invoice          Invoice object.
+     * @param float   $amount amount to validate.
+     */
+    protected function validate_ipn_amount( $invoice, $amount ) {
+        if ( number_format( $invoice->get_total(), 2, '.', '' ) !== number_format( $amount, 2, '.', '' ) ) {
 
-			/* translators: %s: Amount. */
-			$invoice->update_status( 'wpi-processing', sprintf( __( 'Validation error: PayPal amounts do not match (gross %s).', 'invoicing' ), $amount ) );
+            /* translators: %s: Amount. */
+            $invoice->update_status( 'wpi-processing', sprintf( __( 'Validation error: PayPal amounts do not match (gross %s).', 'invoicing' ), $amount ) );
 
-			wpinv_error_log( "Amounts do not match: {$amount} instead of {$invoice->get_total()}", 'IPN Error', __FILE__, __LINE__, true );
-		}
+            wpinv_error_log( "Amounts do not match: {$amount} instead of {$invoice->get_total()}", 'IPN Error', __FILE__, __LINE__, true );
+        }
 
-		wpinv_error_log( $amount, 'Validated IPN Amount', false );
-	}
+        wpinv_error_log( $amount, 'Validated IPN Amount', false );
+    }
 
-	/**
-	 * Verify receiver email from PayPal.
-	 *
-	 * @param WPInv_Invoice $invoice          Invoice object.
-	 * @param string   $receiver_email Email to validate.
-	 */
-	protected function validate_ipn_receiver_email( $invoice, $receiver_email ) {
-		$paypal_email = wpinv_get_option( 'paypal_email' );
+    /**
+     * Verify receiver email from PayPal.
+     *
+     * @param WPInv_Invoice $invoice          Invoice object.
+     * @param string   $receiver_email Email to validate.
+     */
+    protected function validate_ipn_receiver_email( $invoice, $receiver_email ) {
+        $paypal_email = wpinv_get_option( 'paypal_email' );
 
-		if ( strcasecmp( trim( $receiver_email ), trim( $paypal_email ) ) !== 0 ) {
-			wpinv_record_gateway_error( 'IPN Error', "IPN Response is for another account: {$receiver_email}. Your email is {$paypal_email}" );
+        if ( strcasecmp( trim( $receiver_email ), trim( $paypal_email ) ) !== 0 ) {
+            wpinv_record_gateway_error( 'IPN Error', "IPN Response is for another account: {$receiver_email}. Your email is {$paypal_email}" );
 
-			/* translators: %s: email address . */
-			$invoice->update_status( 'wpi-processing', sprintf( __( 'Validation error: PayPal IPN response from a different email address (%s).', 'invoicing' ), $receiver_email ) );
+            /* translators: %s: email address . */
+            $invoice->update_status( 'wpi-processing', sprintf( __( 'Validation error: PayPal IPN response from a different email address (%s).', 'invoicing' ), $receiver_email ) );
 
-			return wpinv_error_log( "IPN Response is for another account: {$receiver_email}. Your email is {$paypal_email}", 'IPN Error', __FILE__, __LINE__, true );
-		}
+            return wpinv_error_log( "IPN Response is for another account: {$receiver_email}. Your email is {$paypal_email}", 'IPN Error', __FILE__, __LINE__, true );
+        }
 
-		wpinv_error_log( 'Validated PayPal Email', false );
-	}
+        wpinv_error_log( 'Validated PayPal Email', false );
+    }
 
-	/**
-	 * Handles one time payments.
-	 *
-	 * @param WPInv_Invoice $invoice  Invoice object.
-	 * @param array    $posted Posted data.
-	 */
-	protected function ipn_txn_web_accept( $invoice, $posted ) {
+    /**
+     * Handles one time payments.
+     *
+     * @param WPInv_Invoice $invoice  Invoice object.
+     * @param array    $posted Posted data.
+     */
+    protected function ipn_txn_web_accept( $invoice, $posted ) {
 
-		// Collect payment details
-		$payment_status = strtolower( $posted['payment_status'] );
-		$business_email = isset( $posted['business'] ) && is_email( $posted['business'] ) ? trim( $posted['business'] ) : trim( $posted['receiver_email'] );
+        // Collect payment details
+        $payment_status = strtolower( $posted['payment_status'] );
+        $business_email = isset( $posted['business'] ) && is_email( $posted['business'] ) ? trim( $posted['business'] ) : trim( $posted['receiver_email'] );
 
-		$this->validate_ipn_receiver_email( $invoice, $business_email );
-		$this->validate_ipn_currency( $invoice, $posted['mc_currency'] );
+        $this->validate_ipn_receiver_email( $invoice, $business_email );
+        $this->validate_ipn_currency( $invoice, $posted['mc_currency'] );
 
-		// Update the transaction id.
-		if ( ! empty( $posted['txn_id'] ) ) {
-			$invoice->set_transaction_id( wpinv_clean( $posted['txn_id'] ) );
-			$invoice->save();
-		}
+        // Update the transaction id.
+        if ( ! empty( $posted['txn_id'] ) ) {
+            $invoice->set_transaction_id( wpinv_clean( $posted['txn_id'] ) );
+            $invoice->save();
+        }
 
-		$invoice->add_system_note( __( 'Processing invoice IPN', 'invoicing' ) );
+        $invoice->add_system_note( __( 'Processing invoice IPN', 'invoicing' ) );
 
-		// Process a refund.
-		if ( $payment_status == 'refunded' || $payment_status == 'reversed' ) {
+        // Process a refund.
+        if ( $payment_status == 'refunded' || $payment_status == 'reversed' ) {
 
-			update_post_meta( $invoice->get_id(), 'refunded_remotely', 1 );
+            update_post_meta( $invoice->get_id(), 'refunded_remotely', 1 );
 
-			if ( ! $invoice->is_refunded() ) {
-				$invoice->update_status( 'wpi-refunded', $posted['reason_code'] );
-			}
+            if ( ! $invoice->is_refunded() ) {
+                $invoice->update_status( 'wpi-refunded', $posted['reason_code'] );
+            }
 
-			return wpinv_error_log( $posted['reason_code'], false );
-		}
+            return wpinv_error_log( $posted['reason_code'], false );
+        }
 
-		// Process payments.
-		if ( $payment_status == 'completed' ) {
+        // Process payments.
+        if ( $payment_status == 'completed' ) {
 
-			if ( $invoice->is_paid() && 'wpi_processing' != $invoice->get_status() ) {
-				return wpinv_error_log( 'Aborting, Invoice #' . $invoice->get_number() . ' is already paid.', false );
-			}
+            if ( $invoice->is_paid() && 'wpi_processing' != $invoice->get_status() ) {
+                return wpinv_error_log( 'Aborting, Invoice #' . $invoice->get_number() . ' is already paid.', false );
+            }
 
-			$this->validate_ipn_amount( $invoice, $posted['mc_gross'] );
+            $this->validate_ipn_amount( $invoice, $posted['mc_gross'] );
 
-			$note = '';
+            $note = '';
 
-			if ( ! empty( $posted['mc_fee'] ) ) {
-				$note = sprintf( __( 'PayPal Transaction Fee %s.', 'invoicing' ), sanitize_text_field( $posted['mc_fee'] ) );
-			}
+            if ( ! empty( $posted['mc_fee'] ) ) {
+                $note = sprintf( __( 'PayPal Transaction Fee %s.', 'invoicing' ), sanitize_text_field( $posted['mc_fee'] ) );
+            }
 
-			if ( ! empty( $posted['payer_status'] ) ) {
-				$note = ' ' . sprintf( __( 'Buyer status %s.', 'invoicing' ), sanitize_text_field( $posted['payer_status'] ) );
-			}
+            if ( ! empty( $posted['payer_status'] ) ) {
+                $note = ' ' . sprintf( __( 'Buyer status %s.', 'invoicing' ), sanitize_text_field( $posted['payer_status'] ) );
+            }
 
-			$invoice->mark_paid( ( ! empty( $posted['txn_id'] ) ? sanitize_text_field( $posted['txn_id'] ) : '' ), trim( $note ) );
-			return wpinv_error_log( 'Invoice marked as paid.', false );
+            $invoice->mark_paid( ( ! empty( $posted['txn_id'] ) ? sanitize_text_field( $posted['txn_id'] ) : '' ), trim( $note ) );
+            return wpinv_error_log( 'Invoice marked as paid.', false );
 
-		}
+        }
 
-		// Pending payments.
-		if ( $payment_status == 'pending' ) {
+        // Pending payments.
+        if ( $payment_status == 'pending' ) {
 
-			/* translators: %s: pending reason. */
-			$invoice->update_status( 'wpi-onhold', sprintf( __( 'Payment pending (%s).', 'invoicing' ), $posted['pending_reason'] ) );
+            /* translators: %s: pending reason. */
+            $invoice->update_status( 'wpi-onhold', sprintf( __( 'Payment pending (%s).', 'invoicing' ), $posted['pending_reason'] ) );
 
-			return wpinv_error_log( 'Invoice marked as "payment held".', false );
-		}
+            return wpinv_error_log( 'Invoice marked as "payment held".', false );
+        }
 
-		/* translators: %s: payment status. */
-		$invoice->update_status( 'wpi-failed', sprintf( __( 'Payment %s via IPN.', 'invoicing' ), sanitize_text_field( $posted['payment_status'] ) ) );
+        /* translators: %s: payment status. */
+        $invoice->update_status( 'wpi-failed', sprintf( __( 'Payment %s via IPN.', 'invoicing' ), sanitize_text_field( $posted['payment_status'] ) ) );
 
-	}
+    }
 
-	/**
-	 * Handles one time payments.
-	 *
-	 * @param WPInv_Invoice $invoice  Invoice object.
-	 * @param array    $posted Posted data.
-	 */
-	protected function ipn_txn_cart( $invoice, $posted ) {
-		$this->ipn_txn_web_accept( $invoice, $posted );
-	}
+    /**
+     * Handles one time payments.
+     *
+     * @param WPInv_Invoice $invoice  Invoice object.
+     * @param array    $posted Posted data.
+     */
+    protected function ipn_txn_cart( $invoice, $posted ) {
+        $this->ipn_txn_web_accept( $invoice, $posted );
+    }
 
-	/**
-	 * Handles subscription sign ups.
-	 *
-	 * @param WPInv_Invoice $invoice  Invoice object.
-	 * @param array    $posted Posted data.
-	 */
-	protected function ipn_txn_subscr_signup( $invoice, $posted ) {
+    /**
+     * Handles subscription sign ups.
+     *
+     * @param WPInv_Invoice $invoice  Invoice object.
+     * @param array    $posted Posted data.
+     */
+    protected function ipn_txn_subscr_signup( $invoice, $posted ) {
 
-		wpinv_error_log( 'Processing subscription signup', false );
+        wpinv_error_log( 'Processing subscription signup', false );
 
-		// Make sure the invoice has a subscription.
-		$subscription = getpaid_get_invoice_subscription( $invoice );
+        // Make sure the invoice has a subscription.
+        $subscription = getpaid_get_invoice_subscription( $invoice );
 
-		if ( empty( $subscription ) ) {
-			return wpinv_error_log( 'Aborting, Subscription for the invoice ' . $invoice->get_id() . ' not found', false );
-		}
+        if ( empty( $subscription ) ) {
+            return wpinv_error_log( 'Aborting, Subscription for the invoice ' . $invoice->get_id() . ' not found', false );
+        }
 
-		wpinv_error_log( 'Found subscription #' . $subscription->get_id(), false );
+        wpinv_error_log( 'Found subscription #' . $subscription->get_id(), false );
 
-		// Validate the IPN.
-		$business_email = isset( $posted['business'] ) && is_email( $posted['business'] ) ? trim( $posted['business'] ) : trim( $posted['receiver_email'] );
-		$this->validate_ipn_receiver_email( $invoice, $business_email );
-		$this->validate_ipn_currency( $invoice, $posted['mc_currency'] );
+        // Validate the IPN.
+        $business_email = isset( $posted['business'] ) && is_email( $posted['business'] ) ? trim( $posted['business'] ) : trim( $posted['receiver_email'] );
+        $this->validate_ipn_receiver_email( $invoice, $business_email );
+        $this->validate_ipn_currency( $invoice, $posted['mc_currency'] );
 
-		// Activate the subscription.
-		$duration = strtotime( $subscription->get_expiration() ) - strtotime( $subscription->get_date_created() );
-		$subscription->set_date_created( current_time( 'mysql' ) );
-		$subscription->set_expiration( date( 'Y-m-d H:i:s', ( current_time( 'timestamp' ) + $duration ) ) );
-		$subscription->set_profile_id( sanitize_text_field( $posted['subscr_id'] ) );
-		$subscription->activate();
+        // Activate the subscription.
+        $duration = strtotime( $subscription->get_expiration() ) - strtotime( $subscription->get_date_created() );
+        $subscription->set_date_created( current_time( 'mysql' ) );
+        $subscription->set_expiration( date( 'Y-m-d H:i:s', ( current_time( 'timestamp' ) + $duration ) ) );
+        $subscription->set_profile_id( sanitize_text_field( $posted['subscr_id'] ) );
+        $subscription->activate();
 
-		// Set the transaction id.
-		if ( ! empty( $posted['txn_id'] ) ) {
-			$invoice->add_note( sprintf( __( 'PayPal Transaction ID: %s', 'invoicing' ) , $posted['txn_id'] ), false, false, true );
-			$invoice->set_transaction_id( $posted['txn_id'] );
-		}
+        // Set the transaction id.
+        if ( ! empty( $posted['txn_id'] ) ) {
+            $invoice->add_note( sprintf( __( 'PayPal Transaction ID: %s', 'invoicing' ) , $posted['txn_id'] ), false, false, true );
+            $invoice->set_transaction_id( $posted['txn_id'] );
+        }
 
-		// Update the payment status.
-		$invoice->mark_paid();
+        // Update the payment status.
+        $invoice->mark_paid();
 
-		$invoice->add_note( sprintf( __( 'PayPal Subscription ID: %s', 'invoicing' ) , $posted['subscr_id'] ), false, false, true );
+        $invoice->add_note( sprintf( __( 'PayPal Subscription ID: %s', 'invoicing' ) , $posted['subscr_id'] ), false, false, true );
 
-		wpinv_error_log( 'Subscription started.', false );
-	}
+        wpinv_error_log( 'Subscription started.', false );
+    }
 
-	/**
-	 * Handles subscription renewals.
-	 *
-	 * @param WPInv_Invoice $invoice  Invoice object.
-	 * @param array    $posted Posted data.
-	 */
-	protected function ipn_txn_subscr_payment( $invoice, $posted ) {
+    /**
+     * Handles subscription renewals.
+     *
+     * @param WPInv_Invoice $invoice  Invoice object.
+     * @param array    $posted Posted data.
+     */
+    protected function ipn_txn_subscr_payment( $invoice, $posted ) {
 
-		// Make sure the invoice has a subscription.
-		$subscription = getpaid_subscriptions()->get_invoice_subscription( $invoice );
+        // Make sure the invoice has a subscription.
+        $subscription = getpaid_subscriptions()->get_invoice_subscription( $invoice );
 
-		if ( empty( $subscription ) ) {
-			return wpinv_error_log( 'Aborting, Subscription for the invoice ' . $invoice->get_id() . ' not found', false );
-		}
+        if ( empty( $subscription ) ) {
+            return wpinv_error_log( 'Aborting, Subscription for the invoice ' . $invoice->get_id() . ' not found', false );
+        }
 
-		wpinv_error_log( 'Found subscription #' . $subscription->get_id(), false );
+        wpinv_error_log( 'Found subscription #' . $subscription->get_id(), false );
 
-		// PayPal sends a subscr_payment for the first payment too.
-		$date_completed = getpaid_format_date( $invoice->get_date_completed() );
-		$date_created   = getpaid_format_date( $invoice->get_date_created() );
-		$today_date     = getpaid_format_date( current_time( 'mysql' ) );
-		$payment_date   = getpaid_format_date( $posted['payment_date'] );
-		$subscribe_date = getpaid_format_date( $subscription->get_date_created() );
-		$dates          = array_filter( compact( 'date_completed', 'date_created', 'subscribe_date' ) );
+        // PayPal sends a subscr_payment for the first payment too.
+        $date_completed = getpaid_format_date( $invoice->get_date_completed() );
+        $date_created   = getpaid_format_date( $invoice->get_date_created() );
+        $today_date     = getpaid_format_date( current_time( 'mysql' ) );
+        $payment_date   = getpaid_format_date( $posted['payment_date'] );
+        $subscribe_date = getpaid_format_date( $subscription->get_date_created() );
+        $dates          = array_filter( compact( 'date_completed', 'date_created', 'subscribe_date' ) );
 
-		foreach( $dates as $date ) {
+        foreach( $dates as $date ) {
 
-			if ( $date !== $today_date && $date !== $payment_date ) {
-				continue;
-			}
+            if ( $date !== $today_date && $date !== $payment_date ) {
+                continue;
+            }
 
-			if ( ! empty( $posted['txn_id'] ) ) {
-				$invoice->set_transaction_id( sanitize_text_field( $posted['txn_id'] ) );	
-				$invoice->add_note( wp_sprintf( __( 'PayPal Transaction ID: %s', 'invoicing' ) , sanitize_text_field( $posted['txn_id'] ) ), false, false, true );
-			}
+            if ( ! empty( $posted['txn_id'] ) ) {
+                $invoice->set_transaction_id( sanitize_text_field( $posted['txn_id'] ) );	
+                $invoice->add_note( wp_sprintf( __( 'PayPal Transaction ID: %s', 'invoicing' ) , sanitize_text_field( $posted['txn_id'] ) ), false, false, true );
+            }
 
-			return $invoice->mark_paid();
-
-		}
+            return $invoice->mark_paid();
+
+        }
 
-		wpinv_error_log( 'Processing subscription renewal payment for the invoice ' . $invoice->get_id(), false );
-
-		// Abort if the payment is already recorded.
-		if ( wpinv_get_id_by_transaction_id( $posted['txn_id'] ) ) {
-			return wpinv_error_log( 'Aborting, Transaction ' . $posted['txn_id'] .' has already been processed', false );
-		}
-
-		$args = array(
-			'transaction_id' => $posted['txn_id'],
-			'gateway'        => $this->id,
-		);
-
-		$invoice = wpinv_get_invoice( $subscription->add_payment( $args ) );
+        wpinv_error_log( 'Processing subscription renewal payment for the invoice ' . $invoice->get_id(), false );
+
+        // Abort if the payment is already recorded.
+        if ( wpinv_get_id_by_transaction_id( $posted['txn_id'] ) ) {
+            return wpinv_error_log( 'Aborting, Transaction ' . $posted['txn_id'] .' has already been processed', false );
+        }
+
+        $args = array(
+            'transaction_id' => $posted['txn_id'],
+            'gateway'        => $this->id,
+        );
+
+        $invoice = wpinv_get_invoice( $subscription->add_payment( $args ) );
 
-		if ( empty( $invoice ) ) {
-			return;
-		}
+        if ( empty( $invoice ) ) {
+            return;
+        }
 
-		$invoice->add_note( wp_sprintf( __( 'PayPal Transaction ID: %s', 'invoicing' ) , $posted['txn_id'] ), false, false, true );
-		$invoice->add_note( wp_sprintf( __( 'PayPal Subscription ID: %s', 'invoicing' ) , $posted['subscr_id'] ), false, false, true );
+        $invoice->add_note( wp_sprintf( __( 'PayPal Transaction ID: %s', 'invoicing' ) , $posted['txn_id'] ), false, false, true );
+        $invoice->add_note( wp_sprintf( __( 'PayPal Subscription ID: %s', 'invoicing' ) , $posted['subscr_id'] ), false, false, true );
 
-		$subscription->renew();
-		wpinv_error_log( 'Subscription renewed.', false );
+        $subscription->renew();
+        wpinv_error_log( 'Subscription renewed.', false );
 
-	}
+    }
 
-	/**
-	 * Handles subscription cancelations.
-	 *
-	 * @param WPInv_Invoice $invoice  Invoice object.
-	 */
-	protected function ipn_txn_subscr_cancel( $invoice ) {
+    /**
+     * Handles subscription cancelations.
+     *
+     * @param WPInv_Invoice $invoice  Invoice object.
+     */
+    protected function ipn_txn_subscr_cancel( $invoice ) {
 
-		// Make sure the invoice has a subscription.
-		$subscription = getpaid_subscriptions()->get_invoice_subscription( $invoice );
-
-		if ( empty( $subscription ) ) {
-			return wpinv_error_log( 'Aborting, Subscription for the invoice ' . $invoice->get_id() . ' not found', false);
-		}
-
-		wpinv_error_log( 'Processing subscription cancellation for the invoice ' . $invoice->get_id(), false );
-		$subscription->cancel();
-		wpinv_error_log( 'Subscription cancelled.', false );
+        // Make sure the invoice has a subscription.
+        $subscription = getpaid_subscriptions()->get_invoice_subscription( $invoice );
+
+        if ( empty( $subscription ) ) {
+            return wpinv_error_log( 'Aborting, Subscription for the invoice ' . $invoice->get_id() . ' not found', false);
+        }
+
+        wpinv_error_log( 'Processing subscription cancellation for the invoice ' . $invoice->get_id(), false );
+        $subscription->cancel();
+        wpinv_error_log( 'Subscription cancelled.', false );
 
-	}
+    }
 
-	/**
-	 * Handles subscription completions.
-	 *
-	 * @param WPInv_Invoice $invoice  Invoice object.
-	 * @param array    $posted Posted data.
-	 */
-	protected function ipn_txn_subscr_eot( $invoice ) {
+    /**
+     * Handles subscription completions.
+     *
+     * @param WPInv_Invoice $invoice  Invoice object.
+     * @param array    $posted Posted data.
+     */
+    protected function ipn_txn_subscr_eot( $invoice ) {
 
-		// Make sure the invoice has a subscription.
-		$subscription = getpaid_subscriptions()->get_invoice_subscription( $invoice );
+        // Make sure the invoice has a subscription.
+        $subscription = getpaid_subscriptions()->get_invoice_subscription( $invoice );
 
-		if ( empty( $subscription ) ) {
-			return wpinv_error_log( 'Aborting, Subscription for the invoice ' . $invoice->get_id() . ' not found', false );
-		}
+        if ( empty( $subscription ) ) {
+            return wpinv_error_log( 'Aborting, Subscription for the invoice ' . $invoice->get_id() . ' not found', false );
+        }
 
-		wpinv_error_log( 'Processing subscription end of life for the invoice ' . $invoice->get_id(), false );
-		$subscription->complete();
-		wpinv_error_log( 'Subscription completed.', false );
+        wpinv_error_log( 'Processing subscription end of life for the invoice ' . $invoice->get_id(), false );
+        $subscription->complete();
+        wpinv_error_log( 'Subscription completed.', false );
 
-	}
+    }
 
-	/**
-	 * Handles subscription fails.
-	 *
-	 * @param WPInv_Invoice $invoice  Invoice object.
-	 * @param array    $posted Posted data.
-	 */
-	protected function ipn_txn_subscr_failed( $invoice ) {
+    /**
+     * Handles subscription fails.
+     *
+     * @param WPInv_Invoice $invoice  Invoice object.
+     * @param array    $posted Posted data.
+     */
+    protected function ipn_txn_subscr_failed( $invoice ) {
 
-		// Make sure the invoice has a subscription.
-		$subscription = getpaid_subscriptions()->get_invoice_subscription( $invoice );
+        // Make sure the invoice has a subscription.
+        $subscription = getpaid_subscriptions()->get_invoice_subscription( $invoice );
 
-		if ( empty( $subscription ) ) {
-			return wpinv_error_log( 'Aborting, Subscription for the invoice ' . $invoice->get_id() . ' not found', false );
-		}
+        if ( empty( $subscription ) ) {
+            return wpinv_error_log( 'Aborting, Subscription for the invoice ' . $invoice->get_id() . ' not found', false );
+        }
 
-		wpinv_error_log( 'Processing subscription payment failure for the invoice ' . $invoice->get_id(), false );
-		$subscription->failing();
-		wpinv_error_log( 'Subscription marked as failing.', false );
+        wpinv_error_log( 'Processing subscription payment failure for the invoice ' . $invoice->get_id(), false );
+        $subscription->failing();
+        wpinv_error_log( 'Subscription marked as failing.', false );
 
-	}
+    }
 
-	/**
-	 * Handles subscription suspensions.
-	 *
-	 * @param WPInv_Invoice $invoice  Invoice object.
-	 * @param array    $posted Posted data.
-	 */
-	protected function ipn_txn_recurring_payment_suspended_due_to_max_failed_payment( $invoice ) {
+    /**
+     * Handles subscription suspensions.
+     *
+     * @param WPInv_Invoice $invoice  Invoice object.
+     * @param array    $posted Posted data.
+     */
+    protected function ipn_txn_recurring_payment_suspended_due_to_max_failed_payment( $invoice ) {
 
-		// Make sure the invoice has a subscription.
-		$subscription = getpaid_subscriptions()->get_invoice_subscription( $invoice );
+        // Make sure the invoice has a subscription.
+        $subscription = getpaid_subscriptions()->get_invoice_subscription( $invoice );
 
-		if ( empty( $subscription ) ) {
-			return wpinv_error_log( 'Aborting, Subscription for the invoice ' . $invoice->get_id() . ' not found', false );
-		}
-
-		wpinv_error_log( 'Processing subscription cancellation due to max failed payment for the invoice ' . $invoice->get_id(), false );
-		$subscription->cancel();
-		wpinv_error_log( 'Subscription cancelled.', false );
-	}
+        if ( empty( $subscription ) ) {
+            return wpinv_error_log( 'Aborting, Subscription for the invoice ' . $invoice->get_id() . ' not found', false );
+        }
+
+        wpinv_error_log( 'Processing subscription cancellation due to max failed payment for the invoice ' . $invoice->get_id(), false );
+        $subscription->cancel();
+        wpinv_error_log( 'Subscription cancelled.', false );
+    }
 
 }

includes/admin/class-wpinv-subscriptions-list-table.php

Indentation +442 added lines, -442 removed lines

@@ -6,7 +6,7 @@ 
 if ( ! defined( 'ABSPATH' ) ) exit;
 
 if ( ! class_exists( 'WP_List_Table' ) ) {
-	include_once ABSPATH . 'wp-admin/includes/class-wp-list-table.php';
+    include_once ABSPATH . 'wp-admin/includes/class-wp-list-table.php';
 }
 
 /**
@@ -14,446 +14,446 @@ 
  */
 class WPInv_Subscriptions_List_Table extends WP_List_Table {
 
-	/**
-	 * URL of this page
-	 *
-	 * @var   string
-	 * @since 1.0.19
-	 */
-	public $base_url;
-
-	/**
-	 * Query
-	 *
-	 * @var   GetPaid_Subscriptions_Query
-	 * @since 1.0.19
-	 */
-	public $query;
-
-	/**
-	 * Total subscriptions
-	 *
-	 * @var   string
-	 * @since 1.0.0
-	 */
-	public $total_count;
-
-	/**
-	 * Current status subscriptions
-	 *
-	 * @var   string
-	 * @since 1.0.0
-	 */
-	public $current_total_count;
-
-	/**
-	 * Status counts
-	 *
-	 * @var   array
-	 * @since 1.0.19
-	 */
-	public $status_counts;
-
-	/**
-	 * Number of results to show per page
-	 *
-	 * @var   int
-	 * @since 1.0.0
-	 */
-	public $per_page = 10;
-
-	/**
-	 *  Constructor function.
-	 */
-	public function __construct() {
-
-		parent::__construct(
-			array(
-				'singular' => 'subscription',
-				'plural'   => 'subscriptions',
-			)
-		);
-
-		$this->process_bulk_action();
-
-		$this->prepare_query();
-
-		$this->base_url = remove_query_arg( 'status' );
-
-	}
-
-	/**
-	 *  Prepares the display query
-	 */
-	public function prepare_query() {
-
-		// Prepare query args.
-		$query = array(
-			'number'  => $this->per_page,
-			'paged'   => $this->get_paged(),
-			'status'  => ( isset( $_GET['status'] ) && array_key_exists( $_GET['status'], getpaid_get_subscription_statuses() ) ) ? $_GET['status'] : 'all',
-			'orderby' => ( isset( $_GET['orderby'] ) ) ? $_GET['orderby'] : 'id',
-			'order'   => ( isset( $_GET['order'] ) ) ? $_GET['order'] : 'DESC',
-			'customer_in' => $this->get_user_in(),
-		);
-
-		if ( is_array( $query['customer_in'] ) && empty( $query['customer_in'] ) ) {
-			$this->total_count         = 0;
-			$this->current_total_count = 0;
-			$this->items               = array();
-			$this->status_counts       = array();
-			return;
-		}
-
-		// Prepare class properties.
-		$this->query               = new GetPaid_Subscriptions_Query( $query );
-		$this->total_count         = $this->query->get_total();
-		$this->current_total_count = $this->query->get_total();
-		$this->items               = $this->query->get_results();
-		$this->status_counts       = getpaid_get_subscription_status_counts( $query );
-
-		if ( 'all' != $query['status'] ) {
-			unset( $query['status'] );
-			$this->total_count   = getpaid_get_subscriptions( $query, 'count' );
-		}
-
-	}
-
-	/**
-	 * Get user in.
-	 *
-	 */
-	public function get_user_in() {
-
-		// Abort if no user.
-		if ( empty( $_GET['s'] ) ) {
-			return null;
-		}
-
-		// Or invalid user.
-		$user = wp_unslash( sanitize_text_field( $_REQUEST['s'] ) );
-
-		if ( empty( $user ) ) {
-			return null;
-		}
-
-		// Search matching users.
-		$user  = '*' . $user . '*';
-		$users = new WP_User_Query(
-			array(
-				'fields'      => 'ID',
-				'search'      => $user,
-				'count_total' => false,
-			)
-		);
-
-		return $users->get_results();
-	}
-
-	/**
-	 * Gets the list of views available on this table.
-	 *
-	 * The format is an associative array:
-	 * - `'id' => 'link'`
-	 *
-	 * @since 1.0.0
-	 *
-	 * @return array
-	 */
-	public function get_views() {
-
-		$current  = isset( $_GET['status'] ) ? $_GET['status'] : 'all';
-		$views    = array(
-
-			'all' => sprintf(
-				'<a href="%s" %s>%s&nbsp;<span class="count">(%d)</span></a>',
-				esc_url( add_query_arg( 'status', false, $this->base_url ) ),
-				$current === 'all' ? ' class="current"' : '',
-				__('All','invoicing' ),
-				$this->total_count
-			)
-
-		);
-
-		foreach ( array_filter( $this->status_counts ) as $status => $count ) {
-
-			$views[ $status ] = sprintf(
-				'<a href="%s" %s>%s&nbsp;<span class="count">(%d)</span></a>',
-				esc_url( add_query_arg( 'status', urlencode( $status ), $this->base_url ) ),
-				$current === $status ? ' class="current"' : '',
-				esc_html( getpaid_get_subscription_status_label( $status ) ),
-				$count
-			);
-
-		}
-
-		return $views;
-
-	}
-
-	/**
-	 * Render most columns
-	 *
-	 * @access      private
-	 * @since       1.0.0
-	 * @return      string
-	 */
-	public function column_default( $item, $column_name ) {
-		return apply_filters( "getpaid_subscriptions_table_column_$column_name", $item->$column_name );
-	}
-
-	/**
-	 * This is how checkbox column renders.
-	 *
-	 * @param WPInv_Subscription $item
-	 * @return string
-	 */
-	public function column_cb( $item ) {
-		return sprintf( '<input type="checkbox" name="id[]" value="%s" />', esc_html( $item->get_id() ) );
-	}
-
-	/**
-	 * Status column
-	 *
-	 * @param WPInv_Subscription $item
-	 * @since       1.0.0
-	 * @return      string
-	 */
-	public function column_status( $item ) {
-		return $item->get_status_label_html();
-	}
-
-	/**
-	 * Subscription column
-	 *
-	 * @param WPInv_Subscription $item
-	 * @since       1.0.0
-	 * @return      string
-	 */
-	public function column_subscription( $item ) {
-
-		$username = __( '(Missing User)', 'invoicing' );
-
-		$user = get_userdata( $item->get_customer_id() );
-		if ( $user ) {
-
-			$username = sprintf(
-				'<a href="user-edit.php?user_id=%s">%s</a>',
-				absint( $user->ID ),
-				! empty( $user->display_name ) ? esc_html( $user->display_name ) : sanitize_email( $user->user_email )
-			);
-
-		}
-
-		// translators: $1: is opening link, $2: is subscription id number, $3: is closing link tag, $4: is user's name
-		$column_content = sprintf(
-			_x( '%1$s#%2$s%3$s for %4$s', 'Subscription title on admin table. (e.g.: #211 for John Doe)', 'invoicing' ),
-			'<a href="' . esc_url( admin_url( 'admin.php?page=wpinv-subscriptions&id=' . absint( $item->get_id() ) ) ) . '">',
-			'<strong>' . esc_attr( $item->get_id() ) . '</strong>', '</a>',
-			$username
-		);
-
-		$row_actions = array();
-
-		// View subscription.
-		$view_url    = esc_url( add_query_arg( 'id', $item->get_id(), admin_url( 'admin.php?page=wpinv-subscriptions' ) ));
-		$row_actions['view'] = '<a href="' . $view_url . '">' . __( 'View Subscription', 'invoicing' ) . '</a>';
-
-		// View invoice.
-		$invoice = get_post( $item->get_parent_invoice_id() );
-
-		if ( ! empty( $invoice ) ) {
-			$invoice_url            = get_edit_post_link( $invoice );
-			$row_actions['invoice'] = '<a href="' . $invoice_url . '">' . __( 'View Invoice', 'invoicing' ) . '</a>';
-		}
-
-		$delete_url            = esc_url(
-			wp_nonce_url(
-				add_query_arg(
-					array(
-						'getpaid-admin-action' => 'subscription_manual_delete',
-						'id'                   => $item->get_id(),
-					)
-				),
-				'getpaid-nonce',
-				'getpaid-nonce'
-			)
-		);
-		$row_actions['delete'] = '<a class="text-danger" href="' . $delete_url . '">' . __( 'Delete Subscription', 'invoicing' ) . '</a>';
-
-		$row_actions = $this->row_actions( apply_filters( 'getpaid_subscription_table_row_actions', $row_actions, $item ) );
-
-		return "<strong>$column_content</strong>" . $this->column_amount( $item ) . $row_actions;
-	}
-
-	/**
-	 * Renewal date column
-	 *
-	 * @param WPInv_Subscription $item
-	 * @since       1.0.0
-	 * @return      string
-	 */
-	public function column_renewal_date( $item ) {
-		return getpaid_format_date_value( $item->get_expiration() );
-	}
-
-	/**
-	 * Start date column
-	 *
-	 * @param WPInv_Subscription $item
-	 * @since       1.0.0
-	 * @return      string
-	 */
-	public function column_start_date( $item ) {
-		return getpaid_format_date_value( $item->get_date_created() );
-	}
-
-	/**
-	 * Amount column
-	 *
-	 * @param WPInv_Subscription $item
-	 * @since       1.0.19
-	 * @return      string
-	 */
-	public static function column_amount( $item ) {
-		$amount = getpaid_get_formatted_subscription_amount( $item );
-		return "<span class='text-muted form-text mt-2 mb-2'>$amount</span>";
-	}
-
-	/**
-	 * Billing Times column
-	 *
-	 * @param WPInv_Subscription $item
-	 * @since       1.0.0
-	 * @return      string
-	 */
-	public function column_renewals( $item ) {
-		$max_bills = $item->get_bill_times();
-		return $item->get_times_billed() . ' / ' . ( empty( $max_bills ) ? "&infin;" : $max_bills );
-	}
-
-	/**
-	 * Product ID column
-	 *
-	 * @param WPInv_Subscription $item
-	 * @since       1.0.0
-	 * @return      string
-	 */
-	public function column_item( $item ) {
-		$subscription_group = getpaid_get_invoice_subscription_group( $item->get_parent_invoice_id(), $item->get_id() );
-
-		if ( empty( $subscription_group ) ) {
-			return $this->generate_item_markup( $item->get_product_id() );
-		}
-
-		$markup = array_map( array( $this, 'generate_item_markup' ), array_keys( $subscription_group['items'] ) );
-		return implode( ' | ', $markup );
-
-	}
-
-	/**
-	 * Generates the items markup.
-	 *
-	 * @param int $item_id
-	 * @since       1.0.0
-	 * @return      string
-	 */
-	public static function generate_item_markup( $item_id ) {
-		$item = get_post( $item_id );
-
-		if ( ! empty( $item ) ) {
-			$link = get_edit_post_link( $item );
-			$link = esc_url( $link );
-			$name = esc_html( get_the_title( $item ) );
-			return wpinv_current_user_can_manage_invoicing() ? "<a href='$link'>$name</a>" : $name;
-		} else {
-			return sprintf( __( 'Item #%s', 'invoicing' ), $item_id );
-		}
-
-	}
-
-	/**
-	 * Retrieve the current page number
-	 *
-	 * @return      int
-	 */
-	public function get_paged() {
-		return isset( $_GET['paged'] ) ? absint( $_GET['paged'] ) : 1;
-	}
-
-	/**
-	 * Setup the final data for the table
-	 *
-	 */
-	public function prepare_items() {
-
-		$columns  = $this->get_columns();
-		$hidden   = array();
-		$sortable = $this->get_sortable_columns();
-
-		$this->_column_headers = array( $columns, $hidden, $sortable );
-
-		$this->set_pagination_args(
-			array(
-			'total_items' => $this->current_total_count,
-			'per_page'    => $this->per_page,
-			'total_pages' => ceil( $this->current_total_count / $this->per_page )
-			)
-		);
-	}
-
-	/**
-	 * Table columns
-	 *
-	 * @return array
-	 */
-	public function get_columns(){
-		$columns = array(
-			'cb'                => '<input type="checkbox" />',
-			'subscription'      => __( 'Subscription', 'invoicing' ),
-			'start_date'        => __( 'Start Date', 'invoicing' ),
-			'renewal_date'      => __( 'Next Payment', 'invoicing' ),
-			'renewals'          => __( 'Payments', 'invoicing' ),
-			'item'              => __( 'Items', 'invoicing' ),
-			'status'            => __( 'Status', 'invoicing' ),
-		);
-
-		return apply_filters( 'manage_getpaid_subscriptions_table_columns', $columns );
-	}
-
-	/**
-	 * Sortable table columns.
-	 *
-	 * @return array
-	 */
-	public function get_sortable_columns() {
-		$sortable = array(
-			'subscription' => array( 'id', true ),
-			'start_date'   => array( 'created', true ),
-			'renewal_date' => array( 'expiration', true ),
-			'renewals'     => array( 'bill_times', true ),
-			'item'         => array( 'product_id', true ),
-			'status'       => array( 'status', true ),
-		);
-
-		return apply_filters( 'manage_getpaid_subscriptions_sortable_table_columns', $sortable );
-	}
-
-	/**
-	 * Whether the table has items to display or not
-	 *
-	 * @return bool
-	 */
-	public function has_items() {
-		return ! empty( $this->current_total_count );
-	}
-
-	/**
-	 * Processes bulk actions.
-	 *
-	 */
-	public function process_bulk_action() {
-
-	}
+    /**
+     * URL of this page
+     *
+     * @var   string
+     * @since 1.0.19
+     */
+    public $base_url;
+
+    /**
+     * Query
+     *
+     * @var   GetPaid_Subscriptions_Query
+     * @since 1.0.19
+     */
+    public $query;
+
+    /**
+     * Total subscriptions
+     *
+     * @var   string
+     * @since 1.0.0
+     */
+    public $total_count;
+
+    /**
+     * Current status subscriptions
+     *
+     * @var   string
+     * @since 1.0.0
+     */
+    public $current_total_count;
+
+    /**
+     * Status counts
+     *
+     * @var   array
+     * @since 1.0.19
+     */
+    public $status_counts;
+
+    /**
+     * Number of results to show per page
+     *
+     * @var   int
+     * @since 1.0.0
+     */
+    public $per_page = 10;
+
+    /**
+     *  Constructor function.
+     */
+    public function __construct() {
+
+        parent::__construct(
+            array(
+                'singular' => 'subscription',
+                'plural'   => 'subscriptions',
+            )
+        );
+
+        $this->process_bulk_action();
+
+        $this->prepare_query();
+
+        $this->base_url = remove_query_arg( 'status' );
+
+    }
+
+    /**
+     *  Prepares the display query
+     */
+    public function prepare_query() {
+
+        // Prepare query args.
+        $query = array(
+            'number'  => $this->per_page,
+            'paged'   => $this->get_paged(),
+            'status'  => ( isset( $_GET['status'] ) && array_key_exists( $_GET['status'], getpaid_get_subscription_statuses() ) ) ? $_GET['status'] : 'all',
+            'orderby' => ( isset( $_GET['orderby'] ) ) ? $_GET['orderby'] : 'id',
+            'order'   => ( isset( $_GET['order'] ) ) ? $_GET['order'] : 'DESC',
+            'customer_in' => $this->get_user_in(),
+        );
+
+        if ( is_array( $query['customer_in'] ) && empty( $query['customer_in'] ) ) {
+            $this->total_count         = 0;
+            $this->current_total_count = 0;
+            $this->items               = array();
+            $this->status_counts       = array();
+            return;
+        }
+
+        // Prepare class properties.
+        $this->query               = new GetPaid_Subscriptions_Query( $query );
+        $this->total_count         = $this->query->get_total();
+        $this->current_total_count = $this->query->get_total();
+        $this->items               = $this->query->get_results();
+        $this->status_counts       = getpaid_get_subscription_status_counts( $query );
+
+        if ( 'all' != $query['status'] ) {
+            unset( $query['status'] );
+            $this->total_count   = getpaid_get_subscriptions( $query, 'count' );
+        }
+
+    }
+
+    /**
+     * Get user in.
+     *
+     */
+    public function get_user_in() {
+
+        // Abort if no user.
+        if ( empty( $_GET['s'] ) ) {
+            return null;
+        }
+
+        // Or invalid user.
+        $user = wp_unslash( sanitize_text_field( $_REQUEST['s'] ) );
+
+        if ( empty( $user ) ) {
+            return null;
+        }
+
+        // Search matching users.
+        $user  = '*' . $user . '*';
+        $users = new WP_User_Query(
+            array(
+                'fields'      => 'ID',
+                'search'      => $user,
+                'count_total' => false,
+            )
+        );
+
+        return $users->get_results();
+    }
+
+    /**
+     * Gets the list of views available on this table.
+     *
+     * The format is an associative array:
+     * - `'id' => 'link'`
+     *
+     * @since 1.0.0
+     *
+     * @return array
+     */
+    public function get_views() {
+
+        $current  = isset( $_GET['status'] ) ? $_GET['status'] : 'all';
+        $views    = array(
+
+            'all' => sprintf(
+                '<a href="%s" %s>%s&nbsp;<span class="count">(%d)</span></a>',
+                esc_url( add_query_arg( 'status', false, $this->base_url ) ),
+                $current === 'all' ? ' class="current"' : '',
+                __('All','invoicing' ),
+                $this->total_count
+            )
+
+        );
+
+        foreach ( array_filter( $this->status_counts ) as $status => $count ) {
+
+            $views[ $status ] = sprintf(
+                '<a href="%s" %s>%s&nbsp;<span class="count">(%d)</span></a>',
+                esc_url( add_query_arg( 'status', urlencode( $status ), $this->base_url ) ),
+                $current === $status ? ' class="current"' : '',
+                esc_html( getpaid_get_subscription_status_label( $status ) ),
+                $count
+            );
+
+        }
+
+        return $views;
+
+    }
+
+    /**
+     * Render most columns
+     *
+     * @access      private
+     * @since       1.0.0
+     * @return      string
+     */
+    public function column_default( $item, $column_name ) {
+        return apply_filters( "getpaid_subscriptions_table_column_$column_name", $item->$column_name );
+    }
+
+    /**
+     * This is how checkbox column renders.
+     *
+     * @param WPInv_Subscription $item
+     * @return string
+     */
+    public function column_cb( $item ) {
+        return sprintf( '<input type="checkbox" name="id[]" value="%s" />', esc_html( $item->get_id() ) );
+    }
+
+    /**
+     * Status column
+     *
+     * @param WPInv_Subscription $item
+     * @since       1.0.0
+     * @return      string
+     */
+    public function column_status( $item ) {
+        return $item->get_status_label_html();
+    }
+
+    /**
+     * Subscription column
+     *
+     * @param WPInv_Subscription $item
+     * @since       1.0.0
+     * @return      string
+     */
+    public function column_subscription( $item ) {
+
+        $username = __( '(Missing User)', 'invoicing' );
+
+        $user = get_userdata( $item->get_customer_id() );
+        if ( $user ) {
+
+            $username = sprintf(
+                '<a href="user-edit.php?user_id=%s">%s</a>',
+                absint( $user->ID ),
+                ! empty( $user->display_name ) ? esc_html( $user->display_name ) : sanitize_email( $user->user_email )
+            );
+
+        }
+
+        // translators: $1: is opening link, $2: is subscription id number, $3: is closing link tag, $4: is user's name
+        $column_content = sprintf(
+            _x( '%1$s#%2$s%3$s for %4$s', 'Subscription title on admin table. (e.g.: #211 for John Doe)', 'invoicing' ),
+            '<a href="' . esc_url( admin_url( 'admin.php?page=wpinv-subscriptions&id=' . absint( $item->get_id() ) ) ) . '">',
+            '<strong>' . esc_attr( $item->get_id() ) . '</strong>', '</a>',
+            $username
+        );
+
+        $row_actions = array();
+
+        // View subscription.
+        $view_url    = esc_url( add_query_arg( 'id', $item->get_id(), admin_url( 'admin.php?page=wpinv-subscriptions' ) ));
+        $row_actions['view'] = '<a href="' . $view_url . '">' . __( 'View Subscription', 'invoicing' ) . '</a>';
+
+        // View invoice.
+        $invoice = get_post( $item->get_parent_invoice_id() );
+
+        if ( ! empty( $invoice ) ) {
+            $invoice_url            = get_edit_post_link( $invoice );
+            $row_actions['invoice'] = '<a href="' . $invoice_url . '">' . __( 'View Invoice', 'invoicing' ) . '</a>';
+        }
+
+        $delete_url            = esc_url(
+            wp_nonce_url(
+                add_query_arg(
+                    array(
+                        'getpaid-admin-action' => 'subscription_manual_delete',
+                        'id'                   => $item->get_id(),
+                    )
+                ),
+                'getpaid-nonce',
+                'getpaid-nonce'
+            )
+        );
+        $row_actions['delete'] = '<a class="text-danger" href="' . $delete_url . '">' . __( 'Delete Subscription', 'invoicing' ) . '</a>';
+
+        $row_actions = $this->row_actions( apply_filters( 'getpaid_subscription_table_row_actions', $row_actions, $item ) );
+
+        return "<strong>$column_content</strong>" . $this->column_amount( $item ) . $row_actions;
+    }
+
+    /**
+     * Renewal date column
+     *
+     * @param WPInv_Subscription $item
+     * @since       1.0.0
+     * @return      string
+     */
+    public function column_renewal_date( $item ) {
+        return getpaid_format_date_value( $item->get_expiration() );
+    }
+
+    /**
+     * Start date column
+     *
+     * @param WPInv_Subscription $item
+     * @since       1.0.0
+     * @return      string
+     */
+    public function column_start_date( $item ) {
+        return getpaid_format_date_value( $item->get_date_created() );
+    }
+
+    /**
+     * Amount column
+     *
+     * @param WPInv_Subscription $item
+     * @since       1.0.19
+     * @return      string
+     */
+    public static function column_amount( $item ) {
+        $amount = getpaid_get_formatted_subscription_amount( $item );
+        return "<span class='text-muted form-text mt-2 mb-2'>$amount</span>";
+    }
+
+    /**
+     * Billing Times column
+     *
+     * @param WPInv_Subscription $item
+     * @since       1.0.0
+     * @return      string
+     */
+    public function column_renewals( $item ) {
+        $max_bills = $item->get_bill_times();
+        return $item->get_times_billed() . ' / ' . ( empty( $max_bills ) ? "&infin;" : $max_bills );
+    }
+
+    /**
+     * Product ID column
+     *
+     * @param WPInv_Subscription $item
+     * @since       1.0.0
+     * @return      string
+     */
+    public function column_item( $item ) {
+        $subscription_group = getpaid_get_invoice_subscription_group( $item->get_parent_invoice_id(), $item->get_id() );
+
+        if ( empty( $subscription_group ) ) {
+            return $this->generate_item_markup( $item->get_product_id() );
+        }
+
+        $markup = array_map( array( $this, 'generate_item_markup' ), array_keys( $subscription_group['items'] ) );
+        return implode( ' | ', $markup );
+
+    }
+
+    /**
+     * Generates the items markup.
+     *
+     * @param int $item_id
+     * @since       1.0.0
+     * @return      string
+     */
+    public static function generate_item_markup( $item_id ) {
+        $item = get_post( $item_id );
+
+        if ( ! empty( $item ) ) {
+            $link = get_edit_post_link( $item );
+            $link = esc_url( $link );
+            $name = esc_html( get_the_title( $item ) );
+            return wpinv_current_user_can_manage_invoicing() ? "<a href='$link'>$name</a>" : $name;
+        } else {
+            return sprintf( __( 'Item #%s', 'invoicing' ), $item_id );
+        }
+
+    }
+
+    /**
+     * Retrieve the current page number
+     *
+     * @return      int
+     */
+    public function get_paged() {
+        return isset( $_GET['paged'] ) ? absint( $_GET['paged'] ) : 1;
+    }
+
+    /**
+     * Setup the final data for the table
+     *
+     */
+    public function prepare_items() {
+
+        $columns  = $this->get_columns();
+        $hidden   = array();
+        $sortable = $this->get_sortable_columns();
+
+        $this->_column_headers = array( $columns, $hidden, $sortable );
+
+        $this->set_pagination_args(
+            array(
+            'total_items' => $this->current_total_count,
+            'per_page'    => $this->per_page,
+            'total_pages' => ceil( $this->current_total_count / $this->per_page )
+            )
+        );
+    }
+
+    /**
+     * Table columns
+     *
+     * @return array
+     */
+    public function get_columns(){
+        $columns = array(
+            'cb'                => '<input type="checkbox" />',
+            'subscription'      => __( 'Subscription', 'invoicing' ),
+            'start_date'        => __( 'Start Date', 'invoicing' ),
+            'renewal_date'      => __( 'Next Payment', 'invoicing' ),
+            'renewals'          => __( 'Payments', 'invoicing' ),
+            'item'              => __( 'Items', 'invoicing' ),
+            'status'            => __( 'Status', 'invoicing' ),
+        );
+
+        return apply_filters( 'manage_getpaid_subscriptions_table_columns', $columns );
+    }
+
+    /**
+     * Sortable table columns.
+     *
+     * @return array
+     */
+    public function get_sortable_columns() {
+        $sortable = array(
+            'subscription' => array( 'id', true ),
+            'start_date'   => array( 'created', true ),
+            'renewal_date' => array( 'expiration', true ),
+            'renewals'     => array( 'bill_times', true ),
+            'item'         => array( 'product_id', true ),
+            'status'       => array( 'status', true ),
+        );
+
+        return apply_filters( 'manage_getpaid_subscriptions_sortable_table_columns', $sortable );
+    }
+
+    /**
+     * Whether the table has items to display or not
+     *
+     * @return bool
+     */
+    public function has_items() {
+        return ! empty( $this->current_total_count );
+    }
+
+    /**
+     * Processes bulk actions.
+     *
+     */
+    public function process_bulk_action() {
+
+    }
 
 }

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

Indentation +175 added lines, -175 removed lines

@@ -12,47 +12,47 @@ 
  */
 class GetPaid_Reports_Export {
 
-	/**
-	 * Displays the reports tab.
-	 *
-	 */
-	public function display() {
-
-		echo "<div class='row mt-4' style='max-width: 920px;' >";
-		foreach ( array_keys( getpaid_get_invoice_post_types() ) as $post_type ) {
-			$this->display_post_type_export( $post_type );
-		}
-		$this->display_subscription_export();
-		echo "</div>";
-
-	}
-
-	/**
-	 * Retrieves the download url.
-	 *
-	 */
-	public function get_download_url( $post_type ) {
-
-		return wp_nonce_url(
-			add_query_arg(
-				array(
-					'getpaid-admin-action' => 'export_invoices',
-					'post_type'            => urlencode( $post_type ),
-				)
-			),
-			'getpaid-nonce',
-			'getpaid-nonce'
-		);
-
-	}
-
-	/**
-	 * Displays a single post type export card.
-	 *
-	 */
-	public function display_post_type_export( $post_type ) {
-
-		?>
+    /**
+     * Displays the reports tab.
+     *
+     */
+    public function display() {
+
+        echo "<div class='row mt-4' style='max-width: 920px;' >";
+        foreach ( array_keys( getpaid_get_invoice_post_types() ) as $post_type ) {
+            $this->display_post_type_export( $post_type );
+        }
+        $this->display_subscription_export();
+        echo "</div>";
+
+    }
+
+    /**
+     * Retrieves the download url.
+     *
+     */
+    public function get_download_url( $post_type ) {
+
+        return wp_nonce_url(
+            add_query_arg(
+                array(
+                    'getpaid-admin-action' => 'export_invoices',
+                    'post_type'            => urlencode( $post_type ),
+                )
+            ),
+            'getpaid-nonce',
+            'getpaid-nonce'
+        );
+
+    }
+
+    /**
+     * Displays a single post type export card.
+     *
+     */
+    public function display_post_type_export( $post_type ) {
+
+        ?>
 
 		<div class="col-12 col-md-6">
 			<div class="card m-0 p-0" style="max-width:100%">
@@ -60,11 +60,11 @@ 
 				<div class="card-header">
 					<strong>
 						<?php
-							printf(
-								__( 'Export %s', 'invoicing' ),
-								sanitize_text_field( getpaid_get_post_type_label( $post_type ) )
-							);
-						?>
+                            printf(
+                                __( 'Export %s', 'invoicing' ),
+                                sanitize_text_field( getpaid_get_post_type_label( $post_type ) )
+                            );
+                        ?>
 					</strong>
 				</div>
 
@@ -73,12 +73,12 @@ 
 					<form method="post" action="<?php echo esc_url( $this->get_download_url( $post_type ) ); ?>">
 
 						<?php
-							$this->display_markup( $this->generate_from_date( $post_type ) );
-							$this->display_markup( $this->generate_to_date( $post_type ) );
-							$this->display_markup( $this->generate_post_status_select( $post_type ) );
-							$this->display_markup( $this->generate_file_type_select( $post_type ) );
-							submit_button( __( 'Download', 'invoicing' ) );
-						?>
+                            $this->display_markup( $this->generate_from_date( $post_type ) );
+                            $this->display_markup( $this->generate_to_date( $post_type ) );
+                            $this->display_markup( $this->generate_post_status_select( $post_type ) );
+                            $this->display_markup( $this->generate_file_type_select( $post_type ) );
+                            submit_button( __( 'Download', 'invoicing' ) );
+                        ?>
 
 					</form>
 
@@ -89,122 +89,122 @@ 
 
 		<?php
 
-	}
-
-	/**
-	 * Generates the from date input field.
-	 *
-	 */
-	public function generate_from_date( $post_type ) {
-
-		return aui()->input(
-			array(
-				'name'       => 'from_date',
-				'id'         => esc_attr( "$post_type-from_date" ),
-				'placeholder'=> 'yy-mm-dd',
-				'label'      => __( 'From Date', 'invoicing' ),
-				'label_type' => 'vertical',
-				'label_class' => 'd-block',
-				'type'       => 'datepicker',
-			)
-		);
-
-	}
-
-	/**
-	 * Generates the to date input field.
-	 *
-	 */
-	public function generate_to_date( $post_type ) {
-
-		return aui()->input(
-			array(
-				'name'       => 'to_date',
-				'id'         => esc_attr( "$post_type-to_date" ),
-				'placeholder'=> 'yy-mm-dd',
-				'label'      => __( 'To Date', 'invoicing' ),
-				'label_type' => 'vertical',
-				'label_class' => 'd-block',
-				'type'       => 'datepicker',
-			)
-		);
-
-	}
-
-	/**
-	 * Generates the to post status select field.
-	 *
-	 */
-	public function generate_post_status_select( $post_type ) {
-
-		if ( 'subscriptions' === $post_type ) {
-			$options = getpaid_get_subscription_statuses();
-		} else {
-			$options = wpinv_get_invoice_statuses( true, false, $post_type );
-		}
-
-		return aui()->select(
-			array(
-				'name'        => 'status',
-				'id'          => esc_attr( "$post_type-status" ),
-				'placeholder' => __( 'All Statuses', 'invoicing' ),
-				'label'       => __( 'Status', 'invoicing' ),
-				'label_type'  => 'vertical',
-				'label_class' => 'd-block',
-				'options'     => $options,
-			)
-		);
-
-	}
-
-	/**
-	 * Generates the to file type select field.
-	 *
-	 */
-	public function generate_file_type_select( $post_type ) {
-
-		return aui()->select(
-			array(
-				'name'        => 'file_type',
-				'id'          => esc_attr( "$post_type-file_type" ),
-				'placeholder' => __( 'Select File Type', 'invoicing' ),
-				'label'       => __( 'Export File', 'invoicing' ),
-				'label_type'  => 'vertical',
-				'label_class' => 'd-block',
-				'options'     => array(
-					'csv'  => __( 'CSV', 'invoicing' ),
-					'xml'  => __( 'XML', 'invoicing' ),
-					'json' => __( 'JSON', 'invoicing' ),
-				),
-			)
-		);
-
-	}
-
-	/**
-	 * Displays a field's markup.
-	 *
-	 */
-	public function display_markup( $markup ) {
-
-		echo str_replace(
-			array(
-				'form-control',
-				'custom-select'
-			),
-			'regular-text',
-			$markup
-		);
-
-	}
-
-	/**
-	 * Displays a subscription export card.
-	 *
-	 */
-	public function display_subscription_export() {
-
-		?>
+    }
+
+    /**
+     * Generates the from date input field.
+     *
+     */
+    public function generate_from_date( $post_type ) {
+
+        return aui()->input(
+            array(
+                'name'       => 'from_date',
+                'id'         => esc_attr( "$post_type-from_date" ),
+                'placeholder'=> 'yy-mm-dd',
+                'label'      => __( 'From Date', 'invoicing' ),
+                'label_type' => 'vertical',
+                'label_class' => 'd-block',
+                'type'       => 'datepicker',
+            )
+        );
+
+    }
+
+    /**
+     * Generates the to date input field.
+     *
+     */
+    public function generate_to_date( $post_type ) {
+
+        return aui()->input(
+            array(
+                'name'       => 'to_date',
+                'id'         => esc_attr( "$post_type-to_date" ),
+                'placeholder'=> 'yy-mm-dd',
+                'label'      => __( 'To Date', 'invoicing' ),
+                'label_type' => 'vertical',
+                'label_class' => 'd-block',
+                'type'       => 'datepicker',
+            )
+        );
+
+    }
+
+    /**
+     * Generates the to post status select field.
+     *
+     */
+    public function generate_post_status_select( $post_type ) {
+
+        if ( 'subscriptions' === $post_type ) {
+            $options = getpaid_get_subscription_statuses();
+        } else {
+            $options = wpinv_get_invoice_statuses( true, false, $post_type );
+        }
+
+        return aui()->select(
+            array(
+                'name'        => 'status',
+                'id'          => esc_attr( "$post_type-status" ),
+                'placeholder' => __( 'All Statuses', 'invoicing' ),
+                'label'       => __( 'Status', 'invoicing' ),
+                'label_type'  => 'vertical',
+                'label_class' => 'd-block',
+                'options'     => $options,
+            )
+        );
+
+    }
+
+    /**
+     * Generates the to file type select field.
+     *
+     */
+    public function generate_file_type_select( $post_type ) {
+
+        return aui()->select(
+            array(
+                'name'        => 'file_type',
+                'id'          => esc_attr( "$post_type-file_type" ),
+                'placeholder' => __( 'Select File Type', 'invoicing' ),
+                'label'       => __( 'Export File', 'invoicing' ),
+                'label_type'  => 'vertical',
+                'label_class' => 'd-block',
+                'options'     => array(
+                    'csv'  => __( 'CSV', 'invoicing' ),
+                    'xml'  => __( 'XML', 'invoicing' ),
+                    'json' => __( 'JSON', 'invoicing' ),
+                ),
+            )
+        );
+
+    }
+
+    /**
+     * Displays a field's markup.
+     *
+     */
+    public function display_markup( $markup ) {
+
+        echo str_replace(
+            array(
+                'form-control',
+                'custom-select'
+            ),
+            'regular-text',
+            $markup
+        );
+
+    }
+
+    /**
+     * Displays a subscription export card.
+     *
+     */
+    public function display_subscription_export() {
+
+        ?>
 
 		<div class="col-12 col-md-6">
 			<div class="card m-0 p-0" style="max-width:100%">
@@ -220,12 +220,12 @@ 
 					<form method="post" action="<?php echo esc_url( $this->get_download_url( 'subscriptions' ) ); ?>">
 
 						<?php
-							$this->display_markup( $this->generate_from_date( 'subscriptions' ) );
-							$this->display_markup( $this->generate_to_date( 'subscriptions' ) );
-							$this->display_markup( $this->generate_post_status_select( 'subscriptions' ) );
-							$this->display_markup( $this->generate_file_type_select( 'subscriptions' ) );
-							submit_button( __( 'Download', 'invoicing' ) );
-						?>
+                            $this->display_markup( $this->generate_from_date( 'subscriptions' ) );
+                            $this->display_markup( $this->generate_to_date( 'subscriptions' ) );
+                            $this->display_markup( $this->generate_post_status_select( 'subscriptions' ) );
+                            $this->display_markup( $this->generate_file_type_select( 'subscriptions' ) );
+                            submit_button( __( 'Download', 'invoicing' ) );
+                        ?>
 
 					</form>
 
@@ -236,6 +236,6 @@ 
 
 		<?php
 
-	}
+    }
 
 }

includes/reports/class-getpaid-subscription-exporter.php

Indentation +172 added lines, -172 removed lines

@@ -12,177 +12,177 @@
  */
 class GetPaid_Subscription_Exporter extends GetPaid_Graph_Downloader {
 
-	/**
-	 * Retrieves subscription query args.
-	 * 
-	 * @param array $args Args to search for.
-	 * @return array
-	 */
-	public function get_subscription_query_args( $args ) {
-
-		$query_args = array(
-			'status'      => 'all',
-			'number'      => -1,
-			'count_total' => false,
-			'fields'      => 'all',
-		);
-
-		if ( ! empty( $args['status'] ) && in_array( $args['status'], array_keys( getpaid_get_subscription_statuses() ), true ) ) {
-			$query_args['status'] = wpinv_clean( wpinv_parse_list( $args['status'] ) );
-		}
-
-		$date_query = array();
-		if ( ! empty( $args['to_date'] ) ) {
-			$date_query['before'] = wpinv_clean( $args['to_date'] );
-		}
-
-		if ( ! empty( $args['from_date'] ) ) {
-			$date_query['after'] = wpinv_clean( $args['from_date'] );
-		}
-
-		if ( ! empty( $date_query ) ) {
-			$date_query['inclusive']          = true;
-			$query_args['date_created_query'] = array( $date_query );
-		}
-
-		return $query_args;
-	}
-
-	/**
-	 * Retrieves subscriptions.
-	 * 
-	 * @param array $query_args GetPaid_Subscriptions_Query args.
-	 * @return WPInv_Subscription[]
-	 */
-	public function get_subscriptions( $query_args ) {
-
-		// Get subscriptions.
-		$subscriptions = new GetPaid_Subscriptions_Query( $query_args );
-
-		// Prepare the results.
-		return $subscriptions->get_results();
-
-	}
-
-	/**
-	 * Handles the actual download.
-	 *
-	 */
-	public function export( $post_type, $args ) {
-
-		$subscriptions = $this->get_subscriptions( $this->get_subscription_query_args( $args ) );
-		$stream        = $this->prepare_output();
-		$headers       = $this->get_export_fields();
-		$file_type     = $this->prepare_file_type( 'subscriptions' );
-
-		if ( 'csv' == $file_type ) {
-			$this->download_csv( $subscriptions, $stream, $headers );
-		} else if( 'xml' == $file_type ) {
-			$this->download_xml( $subscriptions, $stream, $headers );
-		} else {
-			$this->download_json( $subscriptions, $stream, $headers );
-		}
-
-		fclose( $stream );
-		exit;
-	}
-
-	/**
-	 * Prepares a single subscription for download.
-	 *
-	 * @param WPInv_Subscription $subscription The subscription to prepare..
-	 * @param array $fields The fields to stream.
-	 * @since       1.0.19
-	 * @return array
-	 */
-	public function prepare_row( $subscription, $fields ) {
-
-		$prepared      = array();
-		$amount_fields = $this->get_amount_fields();
-		$invoice       = $subscription->get_parent_payment();
-
-		foreach ( $fields as $field ) {
-
-			$value  = '';
-			$method = "get_$field";
-
-			if ( 0 === stripos( $field, 'customer' ) || 'currency' === $field ) {
-
-				if ( method_exists( $invoice, $method ) ) {
-					$value  = $invoice->$method();
-				}
-
-			} else if ( method_exists( $subscription, $method ) ) {
-				$value  = $subscription->$method();
-			}
-
-			if ( in_array( $field, $amount_fields ) ) {
-				$value  = wpinv_round_amount( wpinv_sanitize_amount( $value ) );
-			}
-
-			$prepared[ $field ] = wpinv_clean( $value );
-
-		}
-
-		return $prepared;
-	}
-
-	/**
-	 * Retrieves export fields.
-	 *
-	 * @since       1.0.19
-	 * @return array
-	 */
-	public function get_export_fields() {
-
-		$fields = array(
-			'id',
-			'currency',
-			'initial_amount',
-			'recurring_amount',
-			'trial_period',
-			'frequency',
-			'period',
-			'bill_times',
-			'parent_payment_id',
-			'profile_id',
-			'product_id',
-			'status',
-			'date_created',
-			'date_expires',
-
-			'customer_id',
-			'customer_first_name',
-			'customer_last_name',
-			'customer_phone',
-			'customer_email',
-			'customer_country',
-			'customer_city',
-			'customer_state',
-			'customer_zip',
-			'customer_company',
-			'customer_vat_number',
-			'customer_address',
-
-    	);
-
-		return apply_filters( 'getpaid_subscription_exporter_get_fields', $fields );
-	}
-
-	/**
-	 * Retrieves amount fields.
-	 *
-	 * @since       1.0.19
-	 * @return array
-	 */
-	public function get_amount_fields() {
-
-		$fields = array(
-			'initial_amount',
-			'recurring_amount'
-    	);
-
-		return apply_filters( 'getpaid_subscription_exporter_get_amount_fields', $fields );
-	}
+    /**
+     * Retrieves subscription query args.
+     * 
+     * @param array $args Args to search for.
+     * @return array
+     */
+    public function get_subscription_query_args( $args ) {
+
+        $query_args = array(
+            'status'      => 'all',
+            'number'      => -1,
+            'count_total' => false,
+            'fields'      => 'all',
+        );
+
+        if ( ! empty( $args['status'] ) && in_array( $args['status'], array_keys( getpaid_get_subscription_statuses() ), true ) ) {
+            $query_args['status'] = wpinv_clean( wpinv_parse_list( $args['status'] ) );
+        }
+
+        $date_query = array();
+        if ( ! empty( $args['to_date'] ) ) {
+            $date_query['before'] = wpinv_clean( $args['to_date'] );
+        }
+
+        if ( ! empty( $args['from_date'] ) ) {
+            $date_query['after'] = wpinv_clean( $args['from_date'] );
+        }
+
+        if ( ! empty( $date_query ) ) {
+            $date_query['inclusive']          = true;
+            $query_args['date_created_query'] = array( $date_query );
+        }
+
+        return $query_args;
+    }
+
+    /**
+     * Retrieves subscriptions.
+     * 
+     * @param array $query_args GetPaid_Subscriptions_Query args.
+     * @return WPInv_Subscription[]
+     */
+    public function get_subscriptions( $query_args ) {
+
+        // Get subscriptions.
+        $subscriptions = new GetPaid_Subscriptions_Query( $query_args );
+
+        // Prepare the results.
+        return $subscriptions->get_results();
+
+    }
+
+    /**
+     * Handles the actual download.
+     *
+     */
+    public function export( $post_type, $args ) {
+
+        $subscriptions = $this->get_subscriptions( $this->get_subscription_query_args( $args ) );
+        $stream        = $this->prepare_output();
+        $headers       = $this->get_export_fields();
+        $file_type     = $this->prepare_file_type( 'subscriptions' );
+
+        if ( 'csv' == $file_type ) {
+            $this->download_csv( $subscriptions, $stream, $headers );
+        } else if( 'xml' == $file_type ) {
+            $this->download_xml( $subscriptions, $stream, $headers );
+        } else {
+            $this->download_json( $subscriptions, $stream, $headers );
+        }
+
+        fclose( $stream );
+        exit;
+    }
+
+    /**
+     * Prepares a single subscription for download.
+     *
+     * @param WPInv_Subscription $subscription The subscription to prepare..
+     * @param array $fields The fields to stream.
+     * @since       1.0.19
+     * @return array
+     */
+    public function prepare_row( $subscription, $fields ) {
+
+        $prepared      = array();
+        $amount_fields = $this->get_amount_fields();
+        $invoice       = $subscription->get_parent_payment();
+
+        foreach ( $fields as $field ) {
+
+            $value  = '';
+            $method = "get_$field";
+
+            if ( 0 === stripos( $field, 'customer' ) || 'currency' === $field ) {
+
+                if ( method_exists( $invoice, $method ) ) {
+                    $value  = $invoice->$method();
+                }
+
+            } else if ( method_exists( $subscription, $method ) ) {
+                $value  = $subscription->$method();
+            }
+
+            if ( in_array( $field, $amount_fields ) ) {
+                $value  = wpinv_round_amount( wpinv_sanitize_amount( $value ) );
+            }
+
+            $prepared[ $field ] = wpinv_clean( $value );
+
+        }
+
+        return $prepared;
+    }
+
+    /**
+     * Retrieves export fields.
+     *
+     * @since       1.0.19
+     * @return array
+     */
+    public function get_export_fields() {
+
+        $fields = array(
+            'id',
+            'currency',
+            'initial_amount',
+            'recurring_amount',
+            'trial_period',
+            'frequency',
+            'period',
+            'bill_times',
+            'parent_payment_id',
+            'profile_id',
+            'product_id',
+            'status',
+            'date_created',
+            'date_expires',
+
+            'customer_id',
+            'customer_first_name',
+            'customer_last_name',
+            'customer_phone',
+            'customer_email',
+            'customer_country',
+            'customer_city',
+            'customer_state',
+            'customer_zip',
+            'customer_company',
+            'customer_vat_number',
+            'customer_address',
+
+        );
+
+        return apply_filters( 'getpaid_subscription_exporter_get_fields', $fields );
+    }
+
+    /**
+     * Retrieves amount fields.
+     *
+     * @since       1.0.19
+     * @return array
+     */
+    public function get_amount_fields() {
+
+        $fields = array(
+            'initial_amount',
+            'recurring_amount'
+        );
+
+        return apply_filters( 'getpaid_subscription_exporter_get_amount_fields', $fields );
+    }
 
 }

includes/reports/class-getpaid-reports.php

Indentation +103 added lines, -103 removed lines

@@ -12,49 +12,49 @@ 
  */
 class GetPaid_Reports {
 
-	/**
-	 * Class constructor.
-	 *
-	 */
-	public function __construct() {
-		add_action( 'admin_menu', array( $this, 'register_reports_page' ), 20 );
-		add_action( 'wpinv_reports_tab_reports', array( $this, 'display_reports_tab' ) );
-		add_action( 'wpinv_reports_tab_export', array( $this, 'display_exports_tab' ) );
-		add_action( 'getpaid_authenticated_admin_action_download_graph', array( $this, 'download_graph' ) );
-		add_action( 'getpaid_authenticated_admin_action_export_invoices', array( $this, 'export_invoices' ) );
-
-	}
-
-	/**
-	 * Registers the reports page.
-	 *
-	 */
-	public function register_reports_page() {
-
-		add_submenu_page(
+    /**
+     * Class constructor.
+     *
+     */
+    public function __construct() {
+        add_action( 'admin_menu', array( $this, 'register_reports_page' ), 20 );
+        add_action( 'wpinv_reports_tab_reports', array( $this, 'display_reports_tab' ) );
+        add_action( 'wpinv_reports_tab_export', array( $this, 'display_exports_tab' ) );
+        add_action( 'getpaid_authenticated_admin_action_download_graph', array( $this, 'download_graph' ) );
+        add_action( 'getpaid_authenticated_admin_action_export_invoices', array( $this, 'export_invoices' ) );
+
+    }
+
+    /**
+     * Registers the reports page.
+     *
+     */
+    public function register_reports_page() {
+
+        add_submenu_page(
             'wpinv',
             __( 'Reports', 'invoicing' ),
             __( 'Reports', 'invoicing' ),
             wpinv_get_capability(),
             'wpinv-reports',
             array( $this, 'display_reports_page' )
-		);
+        );
 
-	}
+    }
 
-	/**
-	 * Displays the reports page.
-	 *
-	 */
-	public function display_reports_page() {
+    /**
+     * Displays the reports page.
+     *
+     */
+    public function display_reports_page() {
 
-		// Prepare variables.
-		$tabs        = $this->get_tabs();
-		$current_tab = isset( $_GET['tab'] ) ? sanitize_text_field( $_GET['tab'] ) : 'reports';
-		$current_tab = array_key_exists( $current_tab, $tabs ) ? $current_tab : 'reports';
+        // Prepare variables.
+        $tabs        = $this->get_tabs();
+        $current_tab = isset( $_GET['tab'] ) ? sanitize_text_field( $_GET['tab'] ) : 'reports';
+        $current_tab = array_key_exists( $current_tab, $tabs ) ? $current_tab : 'reports';
 
-		// Display the current tab.
-		?>
+        // Display the current tab.
+        ?>
 
         <div class="wrap">
 
@@ -63,19 +63,19 @@ 
 			<nav class="nav-tab-wrapper">
 
 				<?php
-					foreach( $tabs as $key => $label ) {
+                    foreach( $tabs as $key => $label ) {
 
-						$key   = sanitize_text_field( $key );
-						$label = sanitize_text_field( $label );
-						$class = $key == $current_tab ? 'nav-tab nav-tab-active' : 'nav-tab';
-						$url   = esc_url(
-							add_query_arg( 'tab', $key, admin_url( 'admin.php?page=wpinv-reports' ) )
-						);
+                        $key   = sanitize_text_field( $key );
+                        $label = sanitize_text_field( $label );
+                        $class = $key == $current_tab ? 'nav-tab nav-tab-active' : 'nav-tab';
+                        $url   = esc_url(
+                            add_query_arg( 'tab', $key, admin_url( 'admin.php?page=wpinv-reports' ) )
+                        );
 
-						echo "\n\t\t\t<a href='$url' class='$class'>$label</a>";
+                        echo "\n\t\t\t<a href='$url' class='$class'>$label</a>";
 
-					}
-				?>
+                    }
+                ?>
 
 			</nav>
 
@@ -86,83 +86,83 @@ 
         </div>
 		<?php
 
-			// Wordfence loads an unsupported version of chart js on our page.
-			wp_deregister_style( 'chart-js' );
-			wp_deregister_script( 'chart-js' );
-			wp_enqueue_script( 'chart-js', WPINV_PLUGIN_URL . 'assets/js/chart.bundle.min.js', array( 'jquery' ), '2.9.4', true );
-			wp_enqueue_style( 'chart-js', WPINV_PLUGIN_URL . 'assets/css/chart.min.css', array(), '2.9.4' );
+            // Wordfence loads an unsupported version of chart js on our page.
+            wp_deregister_style( 'chart-js' );
+            wp_deregister_script( 'chart-js' );
+            wp_enqueue_script( 'chart-js', WPINV_PLUGIN_URL . 'assets/js/chart.bundle.min.js', array( 'jquery' ), '2.9.4', true );
+            wp_enqueue_style( 'chart-js', WPINV_PLUGIN_URL . 'assets/css/chart.min.css', array(), '2.9.4' );
 
-	}
+    }
 
-	/**
-	 * Retrieves reports page tabs.
-	 *
-	 * @return array
-	 */
-	public function get_tabs() {
+    /**
+     * Retrieves reports page tabs.
+     *
+     * @return array
+     */
+    public function get_tabs() {
 
-		$tabs = array(
-			'reports' => __( 'Reports', 'invoicing' ),
-			'export'  => __( 'Export', 'invoicing' ),
-		);
+        $tabs = array(
+            'reports' => __( 'Reports', 'invoicing' ),
+            'export'  => __( 'Export', 'invoicing' ),
+        );
 
-		return apply_filters( 'getpaid_report_tabs', $tabs );
-	}
+        return apply_filters( 'getpaid_report_tabs', $tabs );
+    }
 
-	/**
-	 * Displays the reports tab.
-	 *
-	 */
-	public function display_reports_tab() {
+    /**
+     * Displays the reports tab.
+     *
+     */
+    public function display_reports_tab() {
 
-		$reports = new GetPaid_Reports_Report();
-		$reports->display();
+        $reports = new GetPaid_Reports_Report();
+        $reports->display();
 
-	}
+    }
 
-	/**
-	 * Displays the exports tab.
-	 *
-	 */
-	public function display_exports_tab() {
+    /**
+     * Displays the exports tab.
+     *
+     */
+    public function display_exports_tab() {
 
-		$exports = new GetPaid_Reports_Export();
-		$exports->display();
+        $exports = new GetPaid_Reports_Export();
+        $exports->display();
 
-	}
+    }
 
-	/**
-	 * Donwnloads a graph.
-	 *
-	 * @param array $args
-	 */
-	public function download_graph( $args ) {
+    /**
+     * Donwnloads a graph.
+     *
+     * @param array $args
+     */
+    public function download_graph( $args ) {
 
-		if ( ! empty( $args['graph'] ) ) {
-			$downloader = new GetPaid_Graph_Downloader();
-			$downloader->download( $args['graph'] );
-		}
+        if ( ! empty( $args['graph'] ) ) {
+            $downloader = new GetPaid_Graph_Downloader();
+            $downloader->download( $args['graph'] );
+        }
 
-	}
+    }
 
-	/**
-	 * Exports invoices.
-	 *
-	 * @param array $args
-	 */
-	public function export_invoices( $args ) {
+    /**
+     * Exports invoices.
+     *
+     * @param array $args
+     */
+    public function export_invoices( $args ) {
 
-		if ( ! empty( $args['post_type'] ) ) {
+        if ( ! empty( $args['post_type'] ) ) {
 
-			if ( 'subscriptions' === $args['post_type'] ) {
-				$downloader = new GetPaid_Subscription_Exporter();
-			} else {
-				$downloader = new GetPaid_Invoice_Exporter();
-			}
+            if ( 'subscriptions' === $args['post_type'] ) {
+                $downloader = new GetPaid_Subscription_Exporter();
+            } else {
+                $downloader = new GetPaid_Invoice_Exporter();
+            }
 
-			$downloader->export( $args['post_type'], $args );
-		}
+            $downloader->export( $args['post_type'], $args );
+        }
 
-	}
+    }
 
 }

includes/data/tax-rates.php

Indentation +260 added lines, -260 removed lines

@@ -12,265 +12,265 @@
 
 return array(
 
-	array(
-		'country'      => 'AT', // Austria
-		'state'        => '',
-		'global'       => true,
-		'rate'         => 20,
-		'reduced_rate' => 13,
-		'name'         => __( 'VAT', 'invoicing' ),
-	),
-
-	array(
-		'country'      => 'BE', // Belgium
-		'state'        => '',
-		'global'       => true,
-		'rate'         => 21,
-		'reduced_rate' => 12,
-		'name'         => __( 'VAT', 'invoicing' ),
-	),
-
-	array(
-		'country'      => 'BG', // Bulgaria
-		'state'        => '',
-		'global'       => true,
-		'rate'         => 20,
-		'reduced_rate' => 9,
-		'name'         => __( 'VAT', 'invoicing' ),
-	),
-
-	array(
-		'country'      => 'HR', // Croatia
-		'state'        => '',
-		'global'       => true,
-		'rate'         => 25,
-		'reduced_rate' => 13,
-		'name'         => __( 'VAT', 'invoicing' ),
-	),
-
-	array(
-		'country'      => 'CY', // Cyprus
-		'state'        => '',
-		'global'       => true,
-		'rate'         => 19,
-		'reduced_rate' => 9,
-		'name'         => __( 'VAT', 'invoicing' ),
-	),
-
-	array(
-		'country'      => 'CZ', // Czech Republic
-		'state'        => '',
-		'global'       => true,
-		'rate'         => 21,
-		'reduced_rate' => 15,
-		'name'         => __( 'VAT', 'invoicing' ),
-	),
-
-	array(
-		'country'      => 'DK', // Denmark
-		'state'        => '',
-		'global'       => true,
-		'rate'         => 25,
-		'reduced_rate' => 0,
-		'name'         => __( 'VAT', 'invoicing' ),
-	),
-
-	array(
-		'country'      => 'EE', // Estonia
-		'state'        => '',
-		'global'       => true,
-		'rate'         => 20,
-		'reduced_rate' => 9,
-		'name'         => __( 'VAT', 'invoicing' ),
-	),
-
-	array(
-		'country'      => 'FI', // Finland
-		'state'        => '',
-		'global'       => true,
-		'rate'         => 24,
-		'reduced_rate' => 14,
-		'name'         => __( 'VAT', 'invoicing' ),
-	),
-
-	array(
-		'country'      => 'FR', // France
-		'state'        => '',
-		'global'       => true,
-		'rate'         => 20,
-		'reduced_rate' => 5.5,
-		'name'         => __( 'VAT', 'invoicing' ),
-	),
-
-	array(
-		'country'      => 'DE', // Germany
-		'state'        => '',
-		'global'       => true,
-		'rate'         => 19,
-		'reduced_rate' => 7,
-		'name'         => __( 'VAT', 'invoicing' ),
-	),
-
-	array(
-		'country'      => 'GR', // Greece
-		'state'        => '',
-		'global'       => true,
-		'rate'         => 24,
-		'reduced_rate' => 13,
-		'name'         => __( 'VAT', 'invoicing' ),
-	),
-
-	array(
-		'country'      => 'HU', // Hungary
-		'state'        => '',
-		'global'       => true,
-		'rate'         => 27,
-		'reduced_rate' => 18,
-		'name'         => __( 'VAT', 'invoicing' ),
-	),
-
-	array(
-		'country'      => 'IE', // Ireland
-		'state'        => '',
-		'global'       => true,
-		'rate'         => 23,
-		'reduced_rate' => 13.5,
-		'name'         => __( 'VAT', 'invoicing' ),
-	),
-
-	array(
-		'country'      => 'IT', // Italy
-		'state'        => '',
-		'global'       => true,
-		'rate'         => 22,
-		'reduced_rate' => 10,
-		'name'         => __( 'VAT', 'invoicing' ),
-	),
-
-	array(
-		'country'      => 'LV', // Latvia
-		'state'        => '',
-		'global'       => true,
-		'rate'         => 21,
-		'reduced_rate' => 12,
-		'name'         => __( 'VAT', 'invoicing' ),
-	),
-
-	array(
-		'country'      => 'LT', // Lithuania
-		'state'        => '',
-		'global'       => true,
-		'rate'         => 21,
-		'reduced_rate' => 9,
-		'name'         => __( 'VAT', 'invoicing' ),
-	),
-
-	array(
-		'country'      => 'LU', // Luxembourg
-		'state'        => '',
-		'global'       => true,
-		'rate'         => 17,
-		'reduced_rate' => 14,
-		'name'         => __( 'VAT', 'invoicing' ),
-	),
-
-	array(
-		'country'      => 'MT', // Malta
-		'state'        => '',
-		'global'       => true,
-		'rate'         => 18,
-		'reduced_rate' => 7,
-		'name'         => __( 'VAT', 'invoicing' ),
-	),
-
-	array(
-		'country'      => 'MC', // Monaco
-		'state'        => '',
-		'global'       => true,
-		'rate'         => 20,
-		'reduced_rate' => 10,
-		'name'         => __( 'VAT', 'invoicing' ),
-	),
-
-	array(
-		'country'      => 'NL', // Netherlands
-		'state'        => '',
-		'global'       => true,
-		'rate'         => 21,
-		'reduced_rate' => 9,
-		'name'         => __( 'VAT', 'invoicing' ),
-	),
-
-	array(
-		'country'      => 'PL', // Poland
-		'state'        => '',
-		'global'       => true,
-		'rate'         => 23,
-		'reduced_rate' => 8,
-		'name'         => __( 'VAT', 'invoicing' ),
-	),
-
-	array(
-		'country'      => 'PT', // Portugal
-		'state'        => '',
-		'global'       => true,
-		'rate'         => 23,
-		'reduced_rate' => 13,
-		'name'         => __( 'VAT', 'invoicing' ),
-	),
-
-	array(
-		'country'      => 'RO', // Romania
-		'state'        => '',
-		'global'       => true,
-		'rate'         => 19,
-		'reduced_rate' => 9,
-		'name'         => __( 'VAT', 'invoicing' ),
-	),
-
-	array(
-		'country'      => 'SK', // Slovakia
-		'state'        => '',
-		'global'       => true,
-		'rate'         => 20,
-		'reduced_rate' => 10,
-		'name'         => __( 'VAT', 'invoicing' ),
-	),
-
-	array(
-		'country'      => 'SI', // Slovenia
-		'state'        => '',
-		'global'       => true,
-		'rate'         => 22,
-		'reduced_rate' => 9.5,
-		'name'         => __( 'VAT', 'invoicing' ),
-	),
-
-	array(
-		'country'      => 'ES', // Spain
-		'state'        => '',
-		'global'       => true,
-		'rate'         => 21,
-		'reduced_rate' => 10,
-		'name'         => __( 'VAT', 'invoicing' ),
-	),
-
-	array(
-		'country'      => 'SE', // Sweden
-		'state'        => '',
-		'global'       => true,
-		'rate'         => 25,
-		'reduced_rate' => 12,
-		'name'         => __( 'VAT', 'invoicing' ),
-	),
-
-	array(
-		'country'      => 'GB', // UK
-		'state'        => '',
-		'global'       => true,
-		'rate'         => 20,
-		'reduced_rate' => 5,
-		'name'         => __( 'VAT', 'invoicing' ),
-	)
+    array(
+        'country'      => 'AT', // Austria
+        'state'        => '',
+        'global'       => true,
+        'rate'         => 20,
+        'reduced_rate' => 13,
+        'name'         => __( 'VAT', 'invoicing' ),
+    ),
+
+    array(
+        'country'      => 'BE', // Belgium
+        'state'        => '',
+        'global'       => true,
+        'rate'         => 21,
+        'reduced_rate' => 12,
+        'name'         => __( 'VAT', 'invoicing' ),
+    ),
+
+    array(
+        'country'      => 'BG', // Bulgaria
+        'state'        => '',
+        'global'       => true,
+        'rate'         => 20,
+        'reduced_rate' => 9,
+        'name'         => __( 'VAT', 'invoicing' ),
+    ),
+
+    array(
+        'country'      => 'HR', // Croatia
+        'state'        => '',
+        'global'       => true,
+        'rate'         => 25,
+        'reduced_rate' => 13,
+        'name'         => __( 'VAT', 'invoicing' ),
+    ),
+
+    array(
+        'country'      => 'CY', // Cyprus
+        'state'        => '',
+        'global'       => true,
+        'rate'         => 19,
+        'reduced_rate' => 9,
+        'name'         => __( 'VAT', 'invoicing' ),
+    ),
+
+    array(
+        'country'      => 'CZ', // Czech Republic
+        'state'        => '',
+        'global'       => true,
+        'rate'         => 21,
+        'reduced_rate' => 15,
+        'name'         => __( 'VAT', 'invoicing' ),
+    ),
+
+    array(
+        'country'      => 'DK', // Denmark
+        'state'        => '',
+        'global'       => true,
+        'rate'         => 25,
+        'reduced_rate' => 0,
+        'name'         => __( 'VAT', 'invoicing' ),
+    ),
+
+    array(
+        'country'      => 'EE', // Estonia
+        'state'        => '',
+        'global'       => true,
+        'rate'         => 20,
+        'reduced_rate' => 9,
+        'name'         => __( 'VAT', 'invoicing' ),
+    ),
+
+    array(
+        'country'      => 'FI', // Finland
+        'state'        => '',
+        'global'       => true,
+        'rate'         => 24,
+        'reduced_rate' => 14,
+        'name'         => __( 'VAT', 'invoicing' ),
+    ),
+
+    array(
+        'country'      => 'FR', // France
+        'state'        => '',
+        'global'       => true,
+        'rate'         => 20,
+        'reduced_rate' => 5.5,
+        'name'         => __( 'VAT', 'invoicing' ),
+    ),
+
+    array(
+        'country'      => 'DE', // Germany
+        'state'        => '',
+        'global'       => true,
+        'rate'         => 19,
+        'reduced_rate' => 7,
+        'name'         => __( 'VAT', 'invoicing' ),
+    ),
+
+    array(
+        'country'      => 'GR', // Greece
+        'state'        => '',
+        'global'       => true,
+        'rate'         => 24,
+        'reduced_rate' => 13,
+        'name'         => __( 'VAT', 'invoicing' ),
+    ),
+
+    array(
+        'country'      => 'HU', // Hungary
+        'state'        => '',
+        'global'       => true,
+        'rate'         => 27,
+        'reduced_rate' => 18,
+        'name'         => __( 'VAT', 'invoicing' ),
+    ),
+
+    array(
+        'country'      => 'IE', // Ireland
+        'state'        => '',
+        'global'       => true,
+        'rate'         => 23,
+        'reduced_rate' => 13.5,
+        'name'         => __( 'VAT', 'invoicing' ),
+    ),
+
+    array(
+        'country'      => 'IT', // Italy
+        'state'        => '',
+        'global'       => true,
+        'rate'         => 22,
+        'reduced_rate' => 10,
+        'name'         => __( 'VAT', 'invoicing' ),
+    ),
+
+    array(
+        'country'      => 'LV', // Latvia
+        'state'        => '',
+        'global'       => true,
+        'rate'         => 21,
+        'reduced_rate' => 12,
+        'name'         => __( 'VAT', 'invoicing' ),
+    ),
+
+    array(
+        'country'      => 'LT', // Lithuania
+        'state'        => '',
+        'global'       => true,
+        'rate'         => 21,
+        'reduced_rate' => 9,
+        'name'         => __( 'VAT', 'invoicing' ),
+    ),
+
+    array(
+        'country'      => 'LU', // Luxembourg
+        'state'        => '',
+        'global'       => true,
+        'rate'         => 17,
+        'reduced_rate' => 14,
+        'name'         => __( 'VAT', 'invoicing' ),
+    ),
+
+    array(
+        'country'      => 'MT', // Malta
+        'state'        => '',
+        'global'       => true,
+        'rate'         => 18,
+        'reduced_rate' => 7,
+        'name'         => __( 'VAT', 'invoicing' ),
+    ),
+
+    array(
+        'country'      => 'MC', // Monaco
+        'state'        => '',
+        'global'       => true,
+        'rate'         => 20,
+        'reduced_rate' => 10,
+        'name'         => __( 'VAT', 'invoicing' ),
+    ),
+
+    array(
+        'country'      => 'NL', // Netherlands
+        'state'        => '',
+        'global'       => true,
+        'rate'         => 21,
+        'reduced_rate' => 9,
+        'name'         => __( 'VAT', 'invoicing' ),
+    ),
+
+    array(
+        'country'      => 'PL', // Poland
+        'state'        => '',
+        'global'       => true,
+        'rate'         => 23,
+        'reduced_rate' => 8,
+        'name'         => __( 'VAT', 'invoicing' ),
+    ),
+
+    array(
+        'country'      => 'PT', // Portugal
+        'state'        => '',
+        'global'       => true,
+        'rate'         => 23,
+        'reduced_rate' => 13,
+        'name'         => __( 'VAT', 'invoicing' ),
+    ),
+
+    array(
+        'country'      => 'RO', // Romania
+        'state'        => '',
+        'global'       => true,
+        'rate'         => 19,
+        'reduced_rate' => 9,
+        'name'         => __( 'VAT', 'invoicing' ),
+    ),
+
+    array(
+        'country'      => 'SK', // Slovakia
+        'state'        => '',
+        'global'       => true,
+        'rate'         => 20,
+        'reduced_rate' => 10,
+        'name'         => __( 'VAT', 'invoicing' ),
+    ),
+
+    array(
+        'country'      => 'SI', // Slovenia
+        'state'        => '',
+        'global'       => true,
+        'rate'         => 22,
+        'reduced_rate' => 9.5,
+        'name'         => __( 'VAT', 'invoicing' ),
+    ),
+
+    array(
+        'country'      => 'ES', // Spain
+        'state'        => '',
+        'global'       => true,
+        'rate'         => 21,
+        'reduced_rate' => 10,
+        'name'         => __( 'VAT', 'invoicing' ),
+    ),
+
+    array(
+        'country'      => 'SE', // Sweden
+        'state'        => '',
+        'global'       => true,
+        'rate'         => 25,
+        'reduced_rate' => 12,
+        'name'         => __( 'VAT', 'invoicing' ),
+    ),
+
+    array(
+        'country'      => 'GB', // UK
+        'state'        => '',
+        'global'       => true,
+        'rate'         => 20,
+        'reduced_rate' => 5,
+        'name'         => __( 'VAT', 'invoicing' ),
+    )
 
 );

includes/class-wpinv-item.php

Indentation +732 added lines, -732 removed lines

@@ -1,6 +1,6 @@ 
 <?php
 if ( ! defined( 'ABSPATH' ) ) {
-	exit;
+    exit;
 }
 
 /**
@@ -10,30 +10,30 @@ 
 class WPInv_Item  extends GetPaid_Data {
 
     /**
-	 * Which data store to load.
-	 *
-	 * @var string
-	 */
+     * Which data store to load.
+     *
+     * @var string
+     */
     protected $data_store_name = 'item';
 
     /**
-	 * This is the name of this object type.
-	 *
-	 * @var string
-	 */
-	protected $object_type = 'item';
+     * This is the name of this object type.
+     *
+     * @var string
+     */
+    protected $object_type = 'item';
 
     /**
-	 * Item Data array. This is the core item data exposed in APIs.
-	 *
-	 * @since 1.0.19
-	 * @var array
-	 */
-	protected $data = array(
-		'parent_id'            => 0,
-		'status'               => 'draft',
-		'version'              => '',
-		'date_created'         => null,
+     * Item Data array. This is the core item data exposed in APIs.
+     *
+     * @since 1.0.19
+     * @var array
+     */
+    protected $data = array(
+        'parent_id'            => 0,
+        'status'               => 'draft',
+        'version'              => '',
+        'date_created'         => null,
         'date_modified'        => null,
         'name'                 => '',
         'description'          => '',
@@ -58,13 +58,13 @@ 
     );
 
     /**
-	 * Stores meta in cache for future reads.
-	 *
-	 * A group must be set to to enable caching.
-	 *
-	 * @var string
-	 */
-	protected $cache_group = 'getpaid_items';
+     * Stores meta in cache for future reads.
+     *
+     * A group must be set to to enable caching.
+     *
+     * @var string
+     */
+    protected $cache_group = 'getpaid_items';
 
     /**
      * Stores a reference to the original WP_Post object
@@ -74,37 +74,37 @@ 
     protected $post = null;
 
     /**
-	 * Get the item if ID is passed, otherwise the item is new and empty.
-	 *
-	 * @param  int|object|WPInv_Item|WP_Post $item Item to read.
-	 */
-	public function __construct( $item = 0 ) {
-		parent::__construct( $item );
-
-		if ( ! empty( $item ) && is_numeric( $item ) && 'wpi_item' == get_post_type( $item ) ) {
-			$this->set_id( $item );
-		} elseif ( $item instanceof self ) {
-			$this->set_id( $item->get_id() );
-		} elseif ( ! empty( $item->ID ) ) {
-			$this->set_id( $item->ID );
-		} elseif ( is_scalar( $item ) && $item_id = self::get_item_id_by_field( $item, 'custom_id' ) ) {
-			$this->set_id( $item_id );
-		} elseif ( is_scalar( $item ) && $item_id = self::get_item_id_by_field( $item, 'name' ) ) {
-			$this->set_id( $item_id );
-		} else {
-			$this->set_object_read( true );
-		}
+     * Get the item if ID is passed, otherwise the item is new and empty.
+     *
+     * @param  int|object|WPInv_Item|WP_Post $item Item to read.
+     */
+    public function __construct( $item = 0 ) {
+        parent::__construct( $item );
+
+        if ( ! empty( $item ) && is_numeric( $item ) && 'wpi_item' == get_post_type( $item ) ) {
+            $this->set_id( $item );
+        } elseif ( $item instanceof self ) {
+            $this->set_id( $item->get_id() );
+        } elseif ( ! empty( $item->ID ) ) {
+            $this->set_id( $item->ID );
+        } elseif ( is_scalar( $item ) && $item_id = self::get_item_id_by_field( $item, 'custom_id' ) ) {
+            $this->set_id( $item_id );
+        } elseif ( is_scalar( $item ) && $item_id = self::get_item_id_by_field( $item, 'name' ) ) {
+            $this->set_id( $item_id );
+        } else {
+            $this->set_object_read( true );
+        }
 
         // Load the datastore.
-		$this->data_store = GetPaid_Data_Store::load( $this->data_store_name );
+        $this->data_store = GetPaid_Data_Store::load( $this->data_store_name );
 
-		if ( $this->get_id() > 0 ) {
+        if ( $this->get_id() > 0 ) {
             $this->post = get_post( $this->get_id() );
             $this->ID   = $this->get_id();
-			$this->data_store->read( $this );
+            $this->data_store->read( $this );
         }
 
-	}
+    }
 
     /*
 	|--------------------------------------------------------------------------
@@ -122,401 +122,401 @@ 
     */
 
     /**
-	 * Get parent item ID.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return int
-	 */
-	public function get_parent_id( $context = 'view' ) {
-		return (int) $this->get_prop( 'parent_id', $context );
+     * Get parent item ID.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int
+     */
+    public function get_parent_id( $context = 'view' ) {
+        return (int) $this->get_prop( 'parent_id', $context );
     }
 
     /**
-	 * Get item status.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_status( $context = 'view' ) {
-		return $this->get_prop( 'status', $context );
+     * Get item status.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_status( $context = 'view' ) {
+        return $this->get_prop( 'status', $context );
     }
 
     /**
-	 * Get plugin version when the item was created.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_version( $context = 'view' ) {
-		return $this->get_prop( 'version', $context );
+     * Get plugin version when the item was created.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_version( $context = 'view' ) {
+        return $this->get_prop( 'version', $context );
     }
 
     /**
-	 * Get date when the item was created.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_date_created( $context = 'view' ) {
-		return $this->get_prop( 'date_created', $context );
+     * Get date when the item was created.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_date_created( $context = 'view' ) {
+        return $this->get_prop( 'date_created', $context );
     }
 
     /**
-	 * Get GMT date when the item was created.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_date_created_gmt( $context = 'view' ) {
+     * Get GMT date when the item was created.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_date_created_gmt( $context = 'view' ) {
         $date = $this->get_date_created( $context );
 
         if ( $date ) {
             $date = get_gmt_from_date( $date );
         }
-		return $date;
+        return $date;
     }
 
     /**
-	 * Get date when the item was last modified.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_date_modified( $context = 'view' ) {
-		return $this->get_prop( 'date_modified', $context );
+     * Get date when the item was last modified.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_date_modified( $context = 'view' ) {
+        return $this->get_prop( 'date_modified', $context );
     }
 
     /**
-	 * Get GMT date when the item was last modified.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_date_modified_gmt( $context = 'view' ) {
+     * Get GMT date when the item was last modified.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_date_modified_gmt( $context = 'view' ) {
         $date = $this->get_date_modified( $context );
 
         if ( $date ) {
             $date = get_gmt_from_date( $date );
         }
-		return $date;
+        return $date;
     }
 
     /**
-	 * Get the item name.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_name( $context = 'view' ) {
-		return $this->get_prop( 'name', $context );
+     * Get the item name.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_name( $context = 'view' ) {
+        return $this->get_prop( 'name', $context );
     }
 
     /**
-	 * Alias of self::get_name().
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_title( $context = 'view' ) {
-		return $this->get_name( $context );
+     * Alias of self::get_name().
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_title( $context = 'view' ) {
+        return $this->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' ) {
-		return $this->get_prop( 'description', $context );
+     * Get the item description.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_description( $context = 'view' ) {
+        return $this->get_prop( 'description', $context );
     }
 
     /**
-	 * Alias of self::get_description().
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_excerpt( $context = 'view' ) {
-		return $this->get_description( $context );
+     * Alias of self::get_description().
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_excerpt( $context = 'view' ) {
+        return $this->get_description( $context );
     }
 
     /**
-	 * Alias of self::get_description().
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_summary( $context = 'view' ) {
-		return $this->get_description( $context );
+     * Alias of self::get_description().
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_summary( $context = 'view' ) {
+        return $this->get_description( $context );
     }
 
     /**
-	 * Get the owner of the item.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return int
-	 */
-	public function get_author( $context = 'view' ) {
-		return (int) $this->get_prop( 'author', $context );
-	}
+     * Get the owner of the item.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int
+     */
+    public function get_author( $context = 'view' ) {
+        return (int) $this->get_prop( 'author', $context );
+    }
 	
-	/**
-	 * Alias of self::get_author().
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return int
-	 */
-	public function get_owner( $context = 'view' ) {
-		return $this->get_author( $context );
-    }
-
-    /**
-	 * Get the price of the item.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return float
-	 */
-	public function get_price( $context = 'view' ) {
+    /**
+     * Alias of self::get_author().
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int
+     */
+    public function get_owner( $context = 'view' ) {
+        return $this->get_author( $context );
+    }
+
+    /**
+     * Get the price of the item.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return float
+     */
+    public function get_price( $context = 'view' ) {
         return wpinv_sanitize_amount( $this->get_prop( 'price', $context ) );
-	}
+    }
 
-	/**
-	 * Get the inital price of the item.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return float
-	 */
-	public function get_initial_price( $context = 'view' ) {
+    /**
+     * Get the inital price of the item.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return float
+     */
+    public function get_initial_price( $context = 'view' ) {
 
-		$price = (float) $this->get_price( $context );
+        $price = (float) $this->get_price( $context );
 
-		if ( $this->has_free_trial() ) {
-			$price = 0;
-		}
+        if ( $this->has_free_trial() ) {
+            $price = 0;
+        }
 
         return wpinv_sanitize_amount( apply_filters( 'wpinv_get_initial_item_price', $price, $this ) );
     }
 
     /**
-	 * Returns a formated price.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
+     * Returns a formated price.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
     public function get_the_price() {
         return wpinv_price( $this->get_price() );
-	}
-
-	/**
-	 * Returns the formated initial price.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
+    }
+
+    /**
+     * Returns the formated initial price.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
     public function get_the_initial_price() {
         return wpinv_price( $this->get_initial_price() );
     }
 
     /**
-	 * Get the VAT rule of the item.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_vat_rule( $context = 'view' ) {
+     * Get the VAT rule of the item.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_vat_rule( $context = 'view' ) {
         return $this->get_prop( 'vat_rule', $context );
     }
 
     /**
-	 * Get the VAT class of the item.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_vat_class( $context = 'view' ) {
+     * Get the VAT class of the item.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_vat_class( $context = 'view' ) {
         return $this->get_prop( 'vat_class', $context );
     }
 
     /**
-	 * Get the type of the item.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_type( $context = 'view' ) {
+     * Get the type of the item.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_type( $context = 'view' ) {
         return $this->get_prop( 'type', $context );
     }
 
     /**
-	 * Get the custom id of the item.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_custom_id( $context = 'view' ) {
+     * Get the custom id of the item.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_custom_id( $context = 'view' ) {
         return $this->get_prop( 'custom_id', $context );
     }
 
     /**
-	 * Get the custom name of the item.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_custom_name( $context = 'view' ) {
+     * Get the custom name of the item.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_custom_name( $context = 'view' ) {
         return $this->get_prop( 'custom_name', $context );
     }
 
     /**
-	 * Get the custom singular name of the item.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
-	public function get_custom_singular_name( $context = 'view' ) {
+     * Get the custom singular name of the item.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
+    public function get_custom_singular_name( $context = 'view' ) {
         return $this->get_prop( 'custom_singular_name', $context );
     }
 
     /**
-	 * Checks if an item is editable..
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return int
-	 */
-	public function get_is_editable( $context = 'view' ) {
+     * Checks if an item is editable..
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int
+     */
+    public function get_is_editable( $context = 'view' ) {
         return (int) $this->get_prop( 'is_editable', $context );
     }
 
     /**
-	 * Alias of self::get_is_editable().
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return int
-	 */
-	public function get_editable( $context = 'view' ) {
-		return $this->get_is_editable( $context );
+     * Alias of self::get_is_editable().
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int
+     */
+    public function get_editable( $context = 'view' ) {
+        return $this->get_is_editable( $context );
     }
 
     /**
-	 * Checks if dynamic pricing is enabled.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return int
-	 */
-	public function get_is_dynamic_pricing( $context = 'view' ) {
+     * Checks if dynamic pricing is enabled.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int
+     */
+    public function get_is_dynamic_pricing( $context = 'view' ) {
         return (int) $this->get_prop( 'is_dynamic_pricing', $context );
     }
 
     /**
-	 * Returns the minimum price if dynamic pricing is enabled.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return float
-	 */
-	public function get_minimum_price( $context = 'view' ) {
+     * Returns the minimum price if dynamic pricing is enabled.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return float
+     */
+    public function get_minimum_price( $context = 'view' ) {
         return wpinv_sanitize_amount( $this->get_prop( 'minimum_price', $context ) );
     }
 
     /**
-	 * Checks if this is a recurring item.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return int
-	 */
-	public function get_is_recurring( $context = 'view' ) {
+     * Checks if this is a recurring item.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int
+     */
+    public function get_is_recurring( $context = 'view' ) {
         return (int) $this->get_prop( 'is_recurring', $context );
-	}
+    }
 	
-	/**
-	 * Get the recurring price of the item.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return float
-	 */
-	public function get_recurring_price( $context = 'view' ) {
-		$price = $this->get_price( $context );
+    /**
+     * Get the recurring price of the item.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return float
+     */
+    public function get_recurring_price( $context = 'view' ) {
+        $price = $this->get_price( $context );
         return wpinv_sanitize_amount( apply_filters( 'wpinv_get_recurring_item_price', $price, $this->ID ) );
-	}
-
-	/**
-	 * Get the formatted recurring price of the item.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return string
-	 */
+    }
+
+    /**
+     * Get the formatted recurring price of the item.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return string
+     */
     public function get_the_recurring_price() {
         return wpinv_price( $this->get_recurring_price() );
-	}
-
-	/**
-	 * Get the first renewal date (in timestamps) of the item.
-	 *
-	 * @since 1.0.19
-	 * @return int
-	 */
-	public function get_first_renewal_date() {
-
-		$periods = array(
-			'D' => 'days',
-			'W' => 'weeks',
-			'M' => 'months',
-			'Y' => 'years',
-		);
-
-		$period   = $this->get_recurring_period();
-		$interval = $this->get_recurring_interval();
-
-		if ( $this->has_free_trial() ) {
-			$period   = $this->get_trial_period();
-			$interval = $this->get_trial_interval();
-		}
-
-		$period       = $periods[ $period ];
-		$interval     = empty( $interval ) ? 1 : $interval;
-		$next_renewal = strtotime( "+$interval $period", current_time( 'timestamp' ) );
+    }
+
+    /**
+     * Get the first renewal date (in timestamps) of the item.
+     *
+     * @since 1.0.19
+     * @return int
+     */
+    public function get_first_renewal_date() {
+
+        $periods = array(
+            'D' => 'days',
+            'W' => 'weeks',
+            'M' => 'months',
+            'Y' => 'years',
+        );
+
+        $period   = $this->get_recurring_period();
+        $interval = $this->get_recurring_interval();
+
+        if ( $this->has_free_trial() ) {
+            $period   = $this->get_trial_period();
+            $interval = $this->get_trial_interval();
+        }
+
+        $period       = $periods[ $period ];
+        $interval     = empty( $interval ) ? 1 : $interval;
+        $next_renewal = strtotime( "+$interval $period", current_time( 'timestamp' ) );
         return apply_filters( 'wpinv_get_first_renewal_date', $next_renewal, $this );
     }
 
     /**
-	 * Get the recurring period.
-	 *
-	 * @since 1.0.19
-	 * @param  bool $full Return abbreviation or in full.
-	 * @return string
-	 */
-	public function get_recurring_period( $full = false ) {
+     * Get the recurring period.
+     *
+     * @since 1.0.19
+     * @param  bool $full Return abbreviation or in full.
+     * @return string
+     */
+    public function get_recurring_period( $full = false ) {
         $period = $this->get_prop( 'recurring_period', 'view' );
 
         if ( $full && ! is_bool( $full ) ) {
@@ -527,58 +527,58 @@ 
     }
 
     /**
-	 * Get the recurring interval.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return int
-	 */
-	public function get_recurring_interval( $context = 'view' ) {
-		$interval = absint( $this->get_prop( 'recurring_interval', $context ) );
-		return max( 1, $interval );
+     * Get the recurring interval.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int
+     */
+    public function get_recurring_interval( $context = 'view' ) {
+        $interval = absint( $this->get_prop( 'recurring_interval', $context ) );
+        return max( 1, $interval );
     }
 
     /**
-	 * Get the recurring limit.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return int
-	 */
-	public function get_recurring_limit( $context = 'view' ) {
+     * Get the recurring limit.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int
+     */
+    public function get_recurring_limit( $context = 'view' ) {
         return (int) $this->get_prop( 'recurring_limit', $context );
     }
 
     /**
-	 * Checks if we have a free trial.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return int
-	 */
-	public function get_is_free_trial( $context = 'view' ) {
+     * Checks if we have a free trial.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int
+     */
+    public function get_is_free_trial( $context = 'view' ) {
         return (int) $this->get_prop( 'is_free_trial', $context );
     }
 
     /**
-	 * Alias for self::get_is_free_trial().
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return int
-	 */
-	public function get_free_trial( $context = 'view' ) {
+     * Alias for self::get_is_free_trial().
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int
+     */
+    public function get_free_trial( $context = 'view' ) {
         return $this->get_is_free_trial( $context );
     }
 
     /**
-	 * Get the trial period.
-	 *
-	 * @since 1.0.19
-	 * @param  bool $full Return abbreviation or in full.
-	 * @return string
-	 */
-	public function get_trial_period( $full = false ) {
+     * Get the trial period.
+     *
+     * @since 1.0.19
+     * @param  bool $full Return abbreviation or in full.
+     * @return string
+     */
+    public function get_trial_period( $full = false ) {
         $period = $this->get_prop( 'trial_period', 'view' );
 
         if ( $full && ! is_bool( $full ) ) {
@@ -589,104 +589,104 @@ 
     }
 
     /**
-	 * Get the trial interval.
-	 *
-	 * @since 1.0.19
-	 * @param  string $context View or edit context.
-	 * @return int
-	 */
-	public function get_trial_interval( $context = 'view' ) {
+     * Get the trial interval.
+     *
+     * @since 1.0.19
+     * @param  string $context View or edit context.
+     * @return int
+     */
+    public function get_trial_interval( $context = 'view' ) {
         return (int) $this->get_prop( 'trial_interval', $context );
-	}
+    }
 	
-	/**
-	 * Get the item's edit url.
-	 *
-	 * @since 1.0.19
-	 * @return string
-	 */
-	public function get_edit_url() {
+    /**
+     * Get the item's edit url.
+     *
+     * @since 1.0.19
+     * @return string
+     */
+    public function get_edit_url() {
         return get_edit_post_link( $this->get_id(), 'edit' );
-	}
-
-	/**
-	 * Given an item's name/custom id, it returns its id.
-	 *
-	 *
-	 * @static
-	 * @param string $value The item name or custom id.
-	 * @param string $field Either name or custom_id.
-	 * @param string $type in case you need to search for a given type.
-	 * @since 1.0.15
-	 * @return int
-	 */
-	public static function get_item_id_by_field( $value, $field = 'custom_id', $type = '' ) {
-
-		// Trim the value.
-		$value = sanitize_text_field( $value );
-		if ( empty( $value ) ) {
-			return 0;
-		}
+    }
+
+    /**
+     * Given an item's name/custom id, it returns its id.
+     *
+     *
+     * @static
+     * @param string $value The item name or custom id.
+     * @param string $field Either name or custom_id.
+     * @param string $type in case you need to search for a given type.
+     * @since 1.0.15
+     * @return int
+     */
+    public static function get_item_id_by_field( $value, $field = 'custom_id', $type = '' ) {
+
+        // Trim the value.
+        $value = sanitize_text_field( $value );
+        if ( empty( $value ) ) {
+            return 0;
+        }
 
         // Valid fields.
         $fields = array( 'custom_id', 'name', 'slug' );
 
-		// Ensure a field has been passed.
-		if ( empty( $field ) || ! in_array( $field, $fields ) ) {
-			return 0;
-		}
-
-		if ( $field == 'name' ) {
-			$field = 'slug';
-		}
-
-		// Maybe retrieve from the cache.
-		$item_id = wp_cache_get( $value, "getpaid_{$type}_item_{$field}s_to_item_ids" );
-		if ( ! empty( $item_id ) ) {
-			return $item_id;
-		}
-
-		// Fetch from the db.
-		$items = array();
-		if ( $field == 'slug' ) {
-			$items = get_posts(
-				array(
-					'post_type'      => 'wpi_item',
-					'name'           => $value,
-					'posts_per_page' => 1,
-					'post_status'    => 'any',
-				)
-			);
-		}
-
-		if ( $field =='custom_id' ) {
-			$items = get_posts(
-				array(
-					'post_type'      => 'wpi_item',
-					'posts_per_page' => 1,
-					'post_status'    => 'any',
-					'meta_query'     => array(
-						array(
-							'key'   => '_wpinv_type',
-                			'value' => $type,
-						),
-						array(
-							'key'   => '_wpinv_custom_id',
-                			'value' => $value,
-						)
-					)
-				)
-			);
-		}
-
-		if ( empty( $items ) ) {
-			return 0;
-		}
-
-		// Update the cache with our data
-		wp_cache_set( $value, $items[0]->ID, "getpaid_{$type}_item_{$field}s_to_item_ids" );
-
-		return $items[0]->ID;
+        // Ensure a field has been passed.
+        if ( empty( $field ) || ! in_array( $field, $fields ) ) {
+            return 0;
+        }
+
+        if ( $field == 'name' ) {
+            $field = 'slug';
+        }
+
+        // Maybe retrieve from the cache.
+        $item_id = wp_cache_get( $value, "getpaid_{$type}_item_{$field}s_to_item_ids" );
+        if ( ! empty( $item_id ) ) {
+            return $item_id;
+        }
+
+        // Fetch from the db.
+        $items = array();
+        if ( $field == 'slug' ) {
+            $items = get_posts(
+                array(
+                    'post_type'      => 'wpi_item',
+                    'name'           => $value,
+                    'posts_per_page' => 1,
+                    'post_status'    => 'any',
+                )
+            );
+        }
+
+        if ( $field =='custom_id' ) {
+            $items = get_posts(
+                array(
+                    'post_type'      => 'wpi_item',
+                    'posts_per_page' => 1,
+                    'post_status'    => 'any',
+                    'meta_query'     => array(
+                        array(
+                            'key'   => '_wpinv_type',
+                            'value' => $type,
+                        ),
+                        array(
+                            'key'   => '_wpinv_custom_id',
+                            'value' => $value,
+                        )
+                    )
+                )
+            );
+        }
+
+        if ( empty( $items ) ) {
+            return 0;
+        }
+
+        // Update the cache with our data
+        wp_cache_set( $value, $items[0]->ID, "getpaid_{$type}_item_{$field}s_to_item_ids" );
+
+        return $items[0]->ID;
     }
 
     /**
@@ -719,52 +719,52 @@ 
     */
 
     /**
-	 * Set parent order ID.
-	 *
-	 * @since 1.0.19
-	 */
-	public function set_parent_id( $value ) {
-		if ( $value && ( $value === $this->get_id() || ! get_post( $value ) ) ) {
-			return;
-		}
-		$this->set_prop( 'parent_id', absint( $value ) );
-	}
-
-    /**
-	 * Sets item status.
-	 *
-	 * @since 1.0.19
-	 * @param  string $status New status.
-	 * @return array details of change.
-	 */
-	public function set_status( $status ) {
+     * Set parent order ID.
+     *
+     * @since 1.0.19
+     */
+    public function set_parent_id( $value ) {
+        if ( $value && ( $value === $this->get_id() || ! get_post( $value ) ) ) {
+            return;
+        }
+        $this->set_prop( 'parent_id', absint( $value ) );
+    }
+
+    /**
+     * Sets item status.
+     *
+     * @since 1.0.19
+     * @param  string $status New status.
+     * @return array details of change.
+     */
+    public function set_status( $status ) {
         $old_status = $this->get_status();
 
         $this->set_prop( 'status', $status );
 
-		return array(
-			'from' => $old_status,
-			'to'   => $status,
-		);
+        return array(
+            'from' => $old_status,
+            'to'   => $status,
+        );
     }
 
     /**
-	 * Set plugin version when the item was created.
-	 *
-	 * @since 1.0.19
-	 */
-	public function set_version( $value ) {
-		$this->set_prop( 'version', $value );
+     * Set plugin version when the item was created.
+     *
+     * @since 1.0.19
+     */
+    public function set_version( $value ) {
+        $this->set_prop( 'version', $value );
     }
 
     /**
-	 * Set date when the item was created.
-	 *
-	 * @since 1.0.19
-	 * @param string $value Value to set.
+     * Set date when the item was created.
+     *
+     * @since 1.0.19
+     * @param string $value Value to set.
      * @return bool Whether or not the date was set.
-	 */
-	public function set_date_created( $value ) {
+     */
+    public function set_date_created( $value ) {
         $date = strtotime( $value );
 
         if ( $date ) {
@@ -777,13 +777,13 @@ 
     }
 
     /**
-	 * Set date when the item was last modified.
-	 *
-	 * @since 1.0.19
-	 * @param string $value Value to set.
+     * Set date when the item was last modified.
+     *
+     * @since 1.0.19
+     * @param string $value Value to set.
      * @return bool Whether or not the date was set.
-	 */
-	public function set_date_modified( $value ) {
+     */
+    public function set_date_modified( $value ) {
         $date = strtotime( $value );
 
         if ( $date ) {
@@ -796,115 +796,115 @@ 
     }
 
     /**
-	 * Set the item name.
-	 *
-	 * @since 1.0.19
-	 * @param  string $value New name.
-	 */
-	public function set_name( $value ) {
+     * Set the item name.
+     *
+     * @since 1.0.19
+     * @param  string $value New name.
+     */
+    public function set_name( $value ) {
         $name = sanitize_text_field( $value );
-		$this->set_prop( 'name', $name );
+        $this->set_prop( 'name', $name );
     }
 
     /**
-	 * Alias of self::set_name().
-	 *
-	 * @since 1.0.19
-	 * @param  string $value New name.
-	 */
-	public function set_title( $value ) {
-		$this->set_name( $value );
+     * Alias of self::set_name().
+     *
+     * @since 1.0.19
+     * @param  string $value New name.
+     */
+    public function set_title( $value ) {
+        $this->set_name( $value );
     }
 
     /**
-	 * Set the item description.
-	 *
-	 * @since 1.0.19
-	 * @param  string $value New description.
-	 */
-	public function set_description( $value ) {
-		$description = wp_kses_post( wp_unslash( $value ) );
-		return $this->set_prop( 'description', $description );
+     * Set the item description.
+     *
+     * @since 1.0.19
+     * @param  string $value New description.
+     */
+    public function set_description( $value ) {
+        $description = wp_kses_post( wp_unslash( $value ) );
+        return $this->set_prop( 'description', $description );
     }
 
     /**
-	 * Alias of self::set_description().
-	 *
-	 * @since 1.0.19
-	 * @param  string $value New description.
-	 */
-	public function set_excerpt( $value ) {
-		$this->set_description( $value );
+     * Alias of self::set_description().
+     *
+     * @since 1.0.19
+     * @param  string $value New description.
+     */
+    public function set_excerpt( $value ) {
+        $this->set_description( $value );
     }
 
     /**
-	 * Alias of self::set_description().
-	 *
-	 * @since 1.0.19
-	 * @param  string $value New description.
-	 */
-	public function set_summary( $value ) {
-		$this->set_description( $value );
+     * Alias of self::set_description().
+     *
+     * @since 1.0.19
+     * @param  string $value New description.
+     */
+    public function set_summary( $value ) {
+        $this->set_description( $value );
     }
 
     /**
-	 * Set the owner of the item.
-	 *
-	 * @since 1.0.19
-	 * @param  int $value New author.
-	 */
-	public function set_author( $value ) {
-		$this->set_prop( 'author', (int) $value );
-	}
+     * Set the owner of the item.
+     *
+     * @since 1.0.19
+     * @param  int $value New author.
+     */
+    public function set_author( $value ) {
+        $this->set_prop( 'author', (int) $value );
+    }
 	
-	/**
-	 * Alias of self::set_author().
-	 *
-	 * @since 1.0.19
-	 * @param  int $value New author.
-	 */
-	public function set_owner( $value ) {
-		$this->set_author( $value );
-    }
-
-    /**
-	 * Set the price of the item.
-	 *
-	 * @since 1.0.19
-	 * @param  float $value New price.
-	 */
-	public function set_price( $value ) {
+    /**
+     * Alias of self::set_author().
+     *
+     * @since 1.0.19
+     * @param  int $value New author.
+     */
+    public function set_owner( $value ) {
+        $this->set_author( $value );
+    }
+
+    /**
+     * Set the price of the item.
+     *
+     * @since 1.0.19
+     * @param  float $value New price.
+     */
+    public function set_price( $value ) {
         $this->set_prop( 'price', (float) wpinv_sanitize_amount( $value ) );
     }
 
     /**
-	 * Set the VAT rule of the item.
-	 *
-	 * @since 1.0.19
-	 * @param  string $value new rule.
-	 */
-	public function set_vat_rule( $value ) {
+     * Set the VAT rule of the item.
+     *
+     * @since 1.0.19
+     * @param  string $value new rule.
+     */
+    public function set_vat_rule( $value ) {
         $this->set_prop( 'vat_rule', $value );
     }
 
     /**
-	 * Set the VAT class of the item.
-	 *
-	 * @since 1.0.19
-	 * @param  string $value new class.
-	 */
-	public function set_vat_class( $value ) {
+     * Set the VAT class of the item.
+     *
+     * @since 1.0.19
+     * @param  string $value new class.
+     */
+    public function set_vat_class( $value ) {
         $this->set_prop( 'vat_class', $value );
     }
 
     /**
-	 * Set the type of the item.
-	 *
-	 * @since 1.0.19
-	 * @param  string $value new item type.
-	 * @return string
-	 */
-	public function set_type( $value ) {
+     * Set the type of the item.
+     *
+     * @since 1.0.19
+     * @param  string $value new item type.
+     * @return string
+     */
+    public function set_type( $value ) {
 
         if ( empty( $value ) ) {
             $value = 'custom';
@@ -914,132 +914,132 @@ 
     }
 
     /**
-	 * Set the custom id of the item.
-	 *
-	 * @since 1.0.19
-	 * @param  string $value new custom id.
-	 */
-	public function set_custom_id( $value ) {
+     * Set the custom id of the item.
+     *
+     * @since 1.0.19
+     * @param  string $value new custom id.
+     */
+    public function set_custom_id( $value ) {
         $this->set_prop( 'custom_id', $value );
     }
 
     /**
-	 * Set the custom name of the item.
-	 *
-	 * @since 1.0.19
-	 * @param  string $value new custom name.
-	 */
-	public function set_custom_name( $value ) {
+     * Set the custom name of the item.
+     *
+     * @since 1.0.19
+     * @param  string $value new custom name.
+     */
+    public function set_custom_name( $value ) {
         $this->set_prop( 'custom_name', $value );
     }
 
     /**
-	 * Set the custom singular name of the item.
-	 *
-	 * @since 1.0.19
-	 * @param  string $value new custom singular name.
-	 */
-	public function set_custom_singular_name( $value ) {
+     * Set the custom singular name of the item.
+     *
+     * @since 1.0.19
+     * @param  string $value new custom singular name.
+     */
+    public function set_custom_singular_name( $value ) {
         $this->set_prop( 'custom_singular_name', $value );
     }
 
     /**
-	 * Sets if an item is editable..
-	 *
-	 * @since 1.0.19
-	 * @param  int|bool $value whether or not the item is editable.
-	 */
-	public function set_is_editable( $value ) {
-		$this->set_prop( 'is_editable', (int) $value );
+     * Sets if an item is editable..
+     *
+     * @since 1.0.19
+     * @param  int|bool $value whether or not the item is editable.
+     */
+    public function set_is_editable( $value ) {
+        $this->set_prop( 'is_editable', (int) $value );
     }
 
     /**
-	 * Sets if dynamic pricing is enabled.
-	 *
-	 * @since 1.0.19
-	 * @param  int|bool $value whether or not dynamic pricing is allowed.
-	 */
-	public function set_is_dynamic_pricing( $value ) {
+     * Sets if dynamic pricing is enabled.
+     *
+     * @since 1.0.19
+     * @param  int|bool $value whether or not dynamic pricing is allowed.
+     */
+    public function set_is_dynamic_pricing( $value ) {
         $this->set_prop( 'is_dynamic_pricing', (int) $value );
     }
 
     /**
-	 * Sets the minimum price if dynamic pricing is enabled.
-	 *
-	 * @since 1.0.19
-	 * @param  float $value minimum price.
-	 */
-	public function set_minimum_price( $value ) {
+     * Sets the minimum price if dynamic pricing is enabled.
+     *
+     * @since 1.0.19
+     * @param  float $value minimum price.
+     */
+    public function set_minimum_price( $value ) {
         $this->set_prop( 'minimum_price',  (float) wpinv_sanitize_amount( $value ) );
     }
 
     /**
-	 * Sets if this is a recurring item.
-	 *
-	 * @since 1.0.19
-	 * @param  int|bool $value whether or not dynamic pricing is allowed.
-	 */
-	public function set_is_recurring( $value ) {
+     * Sets if this is a recurring item.
+     *
+     * @since 1.0.19
+     * @param  int|bool $value whether or not dynamic pricing is allowed.
+     */
+    public function set_is_recurring( $value ) {
         $this->set_prop( 'is_recurring', (int) $value );
     }
 
     /**
-	 * Set the recurring period.
-	 *
-	 * @since 1.0.19
-	 * @param  string $value new period.
-	 */
-	public function set_recurring_period( $value ) {
+     * Set the recurring period.
+     *
+     * @since 1.0.19
+     * @param  string $value new period.
+     */
+    public function set_recurring_period( $value ) {
         $this->set_prop( 'recurring_period', $value );
     }
 
     /**
-	 * Set the recurring interval.
-	 *
-	 * @since 1.0.19
-	 * @param  int $value recurring interval.
-	 */
-	public function set_recurring_interval( $value ) {
+     * Set the recurring interval.
+     *
+     * @since 1.0.19
+     * @param  int $value recurring interval.
+     */
+    public function set_recurring_interval( $value ) {
         return $this->set_prop( 'recurring_interval', (int) $value );
     }
 
     /**
-	 * Get the recurring limit.
-	 * @since 1.0.19
-	 * @param  int $value The recurring limit.
-	 * @return int
-	 */
-	public function set_recurring_limit( $value ) {
+     * Get the recurring limit.
+     * @since 1.0.19
+     * @param  int $value The recurring limit.
+     * @return int
+     */
+    public function set_recurring_limit( $value ) {
         $this->set_prop( 'recurring_limit', (int) $value );
     }
 
     /**
-	 * Checks if we have a free trial.
-	 *
-	 * @since 1.0.19
-	 * @param  int|bool $value whether or not it has a free trial.
-	 */
-	public function set_is_free_trial( $value ) {
+     * Checks if we have a free trial.
+     *
+     * @since 1.0.19
+     * @param  int|bool $value whether or not it has a free trial.
+     */
+    public function set_is_free_trial( $value ) {
         $this->set_prop( 'is_free_trial', (int) $value );
     }
 
     /**
-	 * Set the trial period.
-	 *
-	 * @since 1.0.19
-	 * @param  string $value trial period.
-	 */
-	public function set_trial_period( $value ) {
+     * Set the trial period.
+     *
+     * @since 1.0.19
+     * @param  string $value trial period.
+     */
+    public function set_trial_period( $value ) {
         $this->set_prop( 'trial_period', $value );
     }
 
     /**
-	 * Set the trial interval.
-	 *
-	 * @since 1.0.19
-	 * @param  int $value trial interval.
-	 */
-	public function set_trial_interval( $value ) {
+     * Set the trial interval.
+     *
+     * @since 1.0.19
+     * @param  int $value trial interval.
+     */
+    public function set_trial_interval( $value ) {
         $this->set_prop( 'trial_interval', $value );
     }
 
@@ -1047,17 +1047,17 @@ 
      * Create an item. For backwards compatibilty.
      * 
      * @deprecated
-	 * @return int item id
+     * @return int item id
      */
     public function create( $data = array() ) {
 
-		// Set the properties.
-		if ( is_array( $data ) ) {
-			$this->set_props( $data );
-		}
+        // Set the properties.
+        if ( is_array( $data ) ) {
+            $this->set_props( $data );
+        }
 
-		// Save the item.
-		return $this->save();
+        // Save the item.
+        return $this->save();
 
     }
 
@@ -1065,7 +1065,7 @@ 
      * Updates an item. For backwards compatibilty.
      * 
      * @deprecated
-	 * @return int item id
+     * @return int item id
      */
     public function update( $data = array() ) {
         return $this->create( $data );
@@ -1081,93 +1081,93 @@ 
 	*/
 
     /**
-	 * Checks whether the item has enabled dynamic pricing.
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
-	public function user_can_set_their_price() {
+     * Checks whether the item has enabled dynamic pricing.
+     *
+     * @since 1.0.19
+     * @return bool
+     */
+    public function user_can_set_their_price() {
         return (bool) $this->get_is_dynamic_pricing();
-	}
+    }
 	
-	/**
-	 * Checks whether the item is recurring.
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
-	public function is_recurring() {
+    /**
+     * Checks whether the item is recurring.
+     *
+     * @since 1.0.19
+     * @return bool
+     */
+    public function is_recurring() {
         return (bool) $this->get_is_recurring();
     }
 
     /**
-	 * Checks whether the item has a free trial.
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
+     * Checks whether the item has a free trial.
+     *
+     * @since 1.0.19
+     * @return bool
+     */
     public function has_free_trial() {
         $has_trial = $this->is_recurring() && (bool) $this->get_free_trial() ? true : false;
         return (bool) apply_filters( 'wpinv_item_has_free_trial', $has_trial, $this->ID, $this );
     }
 
     /**
-	 * Checks whether the item is free.
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
+     * Checks whether the item is free.
+     *
+     * @since 1.0.19
+     * @return bool
+     */
     public function is_free() {
         $is_free   = $this->get_price() == 0;
         return (bool) apply_filters( 'wpinv_is_free_item', $is_free, $this->ID, $this );
     }
 
     /**
-	 * Checks the item status against a passed in status.
-	 *
-	 * @param array|string $status Status to check.
-	 * @return bool
-	 */
-	public function has_status( $status ) {
-		$has_status = ( is_array( $status ) && in_array( $this->get_status(), $status, true ) ) || $this->get_status() === $status;
-		return (bool) apply_filters( 'getpaid_item_has_status', $has_status, $this, $status );
+     * Checks the item status against a passed in status.
+     *
+     * @param array|string $status Status to check.
+     * @return bool
+     */
+    public function has_status( $status ) {
+        $has_status = ( is_array( $status ) && in_array( $this->get_status(), $status, true ) ) || $this->get_status() === $status;
+        return (bool) apply_filters( 'getpaid_item_has_status', $has_status, $this, $status );
     }
 
     /**
-	 * Checks the item type against a passed in types.
-	 *
-	 * @param array|string $type Type to check.
-	 * @return bool
-	 */
-	public function is_type( $type ) {
-		$is_type = ( is_array( $type ) && in_array( $this->get_type(), $type, true ) ) || $this->get_type() === $type;
-		return (bool) apply_filters( 'getpaid_item_is_type', $is_type, $this, $type );
-	}
+     * Checks the item type against a passed in types.
+     *
+     * @param array|string $type Type to check.
+     * @return bool
+     */
+    public function is_type( $type ) {
+        $is_type = ( is_array( $type ) && in_array( $this->get_type(), $type, true ) ) || $this->get_type() === $type;
+        return (bool) apply_filters( 'getpaid_item_is_type', $is_type, $this, $type );
+    }
 
     /**
-	 * Checks whether the item is editable.
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
+     * Checks whether the item is editable.
+     *
+     * @since 1.0.19
+     * @return bool
+     */
     public function is_editable() {
         $is_editable = $this->get_is_editable();
         return (bool) apply_filters( 'wpinv_item_is_editable', $is_editable, $this->ID, $this );
-	}
+    }
 
-	/**
-	 * Returns an array of cart fees.
-	 */
-	public function get_fees() {
+    /**
+     * Returns an array of cart fees.
+     */
+    public function get_fees() {
         return array();
     }
 
     /**
-	 * Checks whether the item is purchasable.
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
+     * Checks whether the item is purchasable.
+     *
+     * @since 1.0.19
+     * @return bool
+     */
     public function can_purchase() {
         $can_purchase = $this->exists();
 
@@ -1179,11 +1179,11 @@ 
     }
 
     /**
-	 * Checks whether the item supports dynamic pricing.
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
+     * Checks whether the item supports dynamic pricing.
+     *
+     * @since 1.0.19
+     * @return bool
+     */
     public function supports_dynamic_pricing() {
         return (bool) apply_filters( 'wpinv_item_supports_dynamic_pricing', true, $this );
     }