AyeCode / invoicing

includes/admin/meta-boxes/class-getpaid-meta-box-payment-form.php

Indentation +10 added lines, -10 removed lines

@@ -7,7 +7,7 @@ 
  */
 
 if ( ! defined( 'ABSPATH' ) ) {
-	exit; // Exit if accessed directly
+    exit; // Exit if accessed directly
 }
 
 /**
@@ -16,10 +16,10 @@ 
 class GetPaid_Meta_Box_Payment_Form {
 
     /**
-	 * Output the metabox.
-	 *
-	 * @param WP_Post $post
-	 */
+     * Output the metabox.
+     *
+     * @param WP_Post $post
+     */
     public static function output( $post ) {
         ?>
         <div id="wpinv-form-builder" class="bsui">
@@ -82,11 +82,11 @@ 
     }
 
     /**
-	 * Save meta box data.
-	 *
-	 * @param int $post_id
-	 */
-	public static function save( $post_id ) {
+     * Save meta box data.
+     *
+     * @param int $post_id
+     */
+    public static function save( $post_id ) {
 
         // verify nonce
         if ( ! isset( $_POST['wpinv_save_payment_form'] ) || ! wp_verify_nonce( $_POST['wpinv_save_payment_form'], 'wpinv_save_payment_form' ) ) {

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

Indentation +193 added lines, -193 removed lines

@@ -4,7 +4,7 @@ 
  *
  */
 if ( ! defined( 'ABSPATH' ) ) {
-	exit;
+    exit;
 }
 
 /**
@@ -14,212 +14,212 @@ 
  */
 class GetPaid_Item_Data_Store extends GetPaid_Data_Store_WP {
 
-	/**
-	 * Data stored in meta keys, but not considered "meta" for an item.
-	 *
-	 * @since 1.0.19
-	 * @var array
-	 */
-	protected $internal_meta_keys = array(
-		'_wpinv_price',
-		'_wpinv_vat_rule',
-		'_wpinv_vat_class',
-		'_wpinv_type',
-		'_wpinv_custom_id',
-		'_wpinv_custom_name',
-		'_wpinv_custom_singular_name',
-		'_wpinv_editable',
-		'_wpinv_dynamic_pricing',
-		'_minimum_price',
-		'_wpinv_is_recurring',
-		'_wpinv_recurring_period',
-		'_wpinv_recurring_interval',
-		'_wpinv_recurring_limit',
-		'_wpinv_free_trial',
-		'_wpinv_trial_period',
-		'_wpinv_trial_interval'
-	);
-
-	/**
-	 * A map of meta keys to data props.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @var array
-	 */
-	protected $meta_key_to_props = array(
-		'_wpinv_price'                => 'price',
-		'_wpinv_vat_rule'             => 'vat_rule',
-		'_wpinv_vat_class'            => 'vat_class',
-		'_wpinv_type'                 => 'type',
-		'_wpinv_custom_id'            => 'custom_id',
-		'_wpinv_custom_name'          => 'custom_name',
-		'_wpinv_custom_singular_name' => 'custom_singular_name',
-		'_wpinv_editable'             => 'is_editable',
-		'_wpinv_dynamic_pricing'      => 'is_dynamic_pricing',
-		'_minimum_price'              => 'minimum_price',
-		'_wpinv_custom_name'          => 'custom_name',
-		'_wpinv_is_recurring'         => 'is_recurring',
-		'_wpinv_recurring_period'     => 'recurring_period',
-		'_wpinv_recurring_interval'   => 'recurring_interval',
-		'_wpinv_recurring_limit'      => 'recurring_limit',
-		'_wpinv_free_trial'           => 'is_free_trial',
-		'_wpinv_trial_period'         => 'trial_period',
-		'_wpinv_trial_interval'       => 'trial_interval',
-		'_wpinv_version'              => 'version',
-	);
-
-	/*
+    /**
+     * Data stored in meta keys, but not considered "meta" for an item.
+     *
+     * @since 1.0.19
+     * @var array
+     */
+    protected $internal_meta_keys = array(
+        '_wpinv_price',
+        '_wpinv_vat_rule',
+        '_wpinv_vat_class',
+        '_wpinv_type',
+        '_wpinv_custom_id',
+        '_wpinv_custom_name',
+        '_wpinv_custom_singular_name',
+        '_wpinv_editable',
+        '_wpinv_dynamic_pricing',
+        '_minimum_price',
+        '_wpinv_is_recurring',
+        '_wpinv_recurring_period',
+        '_wpinv_recurring_interval',
+        '_wpinv_recurring_limit',
+        '_wpinv_free_trial',
+        '_wpinv_trial_period',
+        '_wpinv_trial_interval'
+    );
+
+    /**
+     * A map of meta keys to data props.
+     *
+     * @since 1.0.19
+     *
+     * @var array
+     */
+    protected $meta_key_to_props = array(
+        '_wpinv_price'                => 'price',
+        '_wpinv_vat_rule'             => 'vat_rule',
+        '_wpinv_vat_class'            => 'vat_class',
+        '_wpinv_type'                 => 'type',
+        '_wpinv_custom_id'            => 'custom_id',
+        '_wpinv_custom_name'          => 'custom_name',
+        '_wpinv_custom_singular_name' => 'custom_singular_name',
+        '_wpinv_editable'             => 'is_editable',
+        '_wpinv_dynamic_pricing'      => 'is_dynamic_pricing',
+        '_minimum_price'              => 'minimum_price',
+        '_wpinv_custom_name'          => 'custom_name',
+        '_wpinv_is_recurring'         => 'is_recurring',
+        '_wpinv_recurring_period'     => 'recurring_period',
+        '_wpinv_recurring_interval'   => 'recurring_interval',
+        '_wpinv_recurring_limit'      => 'recurring_limit',
+        '_wpinv_free_trial'           => 'is_free_trial',
+        '_wpinv_trial_period'         => 'trial_period',
+        '_wpinv_trial_interval'       => 'trial_interval',
+        '_wpinv_version'              => 'version',
+    );
+
+    /*
 	|--------------------------------------------------------------------------
 	| CRUD Methods
 	|--------------------------------------------------------------------------
 	*/
 
-	/**
-	 * Method to create a new item in the database.
-	 *
-	 * @param WPInv_Item $item Item object.
-	 */
-	public function create( &$item ) {
-		$item->set_version( WPINV_VERSION );
-		$item->set_date_created( current_time('mysql') );
-
-		// Create a new post.
-		$id = wp_insert_post(
-			apply_filters(
-				'getpaid_new_item_data',
-				array(
-					'post_date'     => $item->get_date_created( 'edit' ),
-					'post_type'     => 'wpi_item',
-					'post_status'   => $this->get_post_status( $item ),
-					'ping_status'   => 'closed',
-					'post_author'   => $item->get_author( 'edit' ),
-					'post_title'    => $item->get_name( 'edit' ),
-					'post_parent'   => 0,
-					'post_excerpt'  => $item->get_description( 'edit' ),
-				)
-			),
-			true
-		);
-
-		if ( $id && ! is_wp_error( $id ) ) {
-			$item->set_id( $id );
-			$this->update_post_meta( $item );
-			$item->save_meta_data();
-			$item->apply_changes();
-			$this->clear_caches( $item );
-			return true;
-		}
-
-		if ( is_wp_error( $id ) ) {
-			$item->last_error = $id->get_error_message();
-		}
+    /**
+     * Method to create a new item in the database.
+     *
+     * @param WPInv_Item $item Item object.
+     */
+    public function create( &$item ) {
+        $item->set_version( WPINV_VERSION );
+        $item->set_date_created( current_time('mysql') );
+
+        // Create a new post.
+        $id = wp_insert_post(
+            apply_filters(
+                'getpaid_new_item_data',
+                array(
+                    'post_date'     => $item->get_date_created( 'edit' ),
+                    'post_type'     => 'wpi_item',
+                    'post_status'   => $this->get_post_status( $item ),
+                    'ping_status'   => 'closed',
+                    'post_author'   => $item->get_author( 'edit' ),
+                    'post_title'    => $item->get_name( 'edit' ),
+                    'post_parent'   => 0,
+                    'post_excerpt'  => $item->get_description( 'edit' ),
+                )
+            ),
+            true
+        );
+
+        if ( $id && ! is_wp_error( $id ) ) {
+            $item->set_id( $id );
+            $this->update_post_meta( $item );
+            $item->save_meta_data();
+            $item->apply_changes();
+            $this->clear_caches( $item );
+            return true;
+        }
+
+        if ( is_wp_error( $id ) ) {
+            $item->last_error = $id->get_error_message();
+        }
 		
-		return false;
-	}
-
-	/**
-	 * Method to read an item from the database.
-	 *
-	 * @param WPInv_Item $item Item object.
-	 *
-	 */
-	public function read( &$item ) {
-
-		$item->set_defaults();
-		$item_object = get_post( $item->get_id() );
-
-		if ( ! $item->get_id() || ! $item_object || $item_object->post_type != 'wpi_item' ) {
-			$item->last_error = __( 'Invalid item.', 'invoicing' );
-			return false;
-		}
-
-		$item->set_props(
-			array(
-				'parent_id'     => $item_object->post_parent,
-				'date_created'  => 0 < $item_object->post_date_gmt ? $item_object->post_date_gmt : null,
-				'date_modified' => 0 < $item_object->post_modified_gmt ? $item_object->post_modified_gmt : null,
-				'status'        => $item_object->post_status,
-				'name'          => $item_object->post_title,
-				'description'   => $item_object->post_excerpt,
-				'author'        => $item_object->post_author,
-			)
-		);
-
-		$this->read_object_data( $item, $item_object );
-		$item->read_meta_data();
-		$item->set_object_read( true );
-
-	}
-
-	/**
-	 * Method to update an item in the database.
-	 *
-	 * @param WPInv_Item $item Item object.
-	 */
-	public function update( &$item ) {
-		$item->save_meta_data();
-		$item->set_version( WPINV_VERSION );
-
-		if ( null === $item->get_date_created( 'edit' ) ) {
-			$item->set_date_created(  current_time('mysql') );
-		}
-
-		$changes = $item->get_changes();
-
-		// Only update the post when the post data changes.
-		if ( array_intersect( array( 'date_created', 'date_modified', 'status', 'parent_id', 'post_excerpt', 'name', 'author' ), array_keys( $changes ) ) ) {
-			$post_data = array(
-				'post_date'         => $item->get_date_created( 'edit' ),
-				'post_status'       => $item->get_status( 'edit' ),
-				'post_parent'       => $item->get_parent_id( 'edit' ),
-				'post_excerpt'      => $item->get_description( 'edit' ),
-				'post_modified'     => $item->get_date_modified( 'edit' ),
-				'post_title'        => $item->get_name( 'edit' ),
-				'post_author'       => $item->get_author( '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' => $item->get_id() ) );
-				clean_post_cache( $item->get_id() );
-			} else {
-				wp_update_post( array_merge( array( 'ID' => $item->get_id() ), $post_data ) );
-			}
-			$item->read_meta_data( true ); // Refresh internal meta data, in case things were hooked into `save_post` or another WP hook.
-		}
-		$this->update_post_meta( $item );
-		$item->apply_changes();
-		$this->clear_caches( $item );
-	}
-
-	/*
+        return false;
+    }
+
+    /**
+     * Method to read an item from the database.
+     *
+     * @param WPInv_Item $item Item object.
+     *
+     */
+    public function read( &$item ) {
+
+        $item->set_defaults();
+        $item_object = get_post( $item->get_id() );
+
+        if ( ! $item->get_id() || ! $item_object || $item_object->post_type != 'wpi_item' ) {
+            $item->last_error = __( 'Invalid item.', 'invoicing' );
+            return false;
+        }
+
+        $item->set_props(
+            array(
+                'parent_id'     => $item_object->post_parent,
+                'date_created'  => 0 < $item_object->post_date_gmt ? $item_object->post_date_gmt : null,
+                'date_modified' => 0 < $item_object->post_modified_gmt ? $item_object->post_modified_gmt : null,
+                'status'        => $item_object->post_status,
+                'name'          => $item_object->post_title,
+                'description'   => $item_object->post_excerpt,
+                'author'        => $item_object->post_author,
+            )
+        );
+
+        $this->read_object_data( $item, $item_object );
+        $item->read_meta_data();
+        $item->set_object_read( true );
+
+    }
+
+    /**
+     * Method to update an item in the database.
+     *
+     * @param WPInv_Item $item Item object.
+     */
+    public function update( &$item ) {
+        $item->save_meta_data();
+        $item->set_version( WPINV_VERSION );
+
+        if ( null === $item->get_date_created( 'edit' ) ) {
+            $item->set_date_created(  current_time('mysql') );
+        }
+
+        $changes = $item->get_changes();
+
+        // Only update the post when the post data changes.
+        if ( array_intersect( array( 'date_created', 'date_modified', 'status', 'parent_id', 'post_excerpt', 'name', 'author' ), array_keys( $changes ) ) ) {
+            $post_data = array(
+                'post_date'         => $item->get_date_created( 'edit' ),
+                'post_status'       => $item->get_status( 'edit' ),
+                'post_parent'       => $item->get_parent_id( 'edit' ),
+                'post_excerpt'      => $item->get_description( 'edit' ),
+                'post_modified'     => $item->get_date_modified( 'edit' ),
+                'post_title'        => $item->get_name( 'edit' ),
+                'post_author'       => $item->get_author( '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' => $item->get_id() ) );
+                clean_post_cache( $item->get_id() );
+            } else {
+                wp_update_post( array_merge( array( 'ID' => $item->get_id() ), $post_data ) );
+            }
+            $item->read_meta_data( true ); // Refresh internal meta data, in case things were hooked into `save_post` or another WP hook.
+        }
+        $this->update_post_meta( $item );
+        $item->apply_changes();
+        $this->clear_caches( $item );
+    }
+
+    /*
 	|--------------------------------------------------------------------------
 	| Additional Methods
 	|--------------------------------------------------------------------------
 	*/
 
-	/**
-	 * Helper method that updates all the post meta for an item based on it's settings in the WPInv_Item class.
-	 *
-	 * @param WPInv_Item $item WPInv_Item object.
-	 * @since 1.0.19
-	 */
-	protected function update_post_meta( &$item ) {
+    /**
+     * Helper method that updates all the post meta for an item based on it's settings in the WPInv_Item class.
+     *
+     * @param WPInv_Item $item WPInv_Item object.
+     * @since 1.0.19
+     */
+    protected function update_post_meta( &$item ) {
 
-		// Ensure that we have a custom id.
+        // Ensure that we have a custom id.
         if ( ! $item->get_custom_id() ) {
             $item->set_custom_id( $item->get_id() );
-		}
+        }
 
-		parent::update_post_meta( $item );
-	}
+        parent::update_post_meta( $item );
+    }
 
 }

includes/data-stores/class-getpaid-payment-form-data-store.php

Indentation +153 added lines, -153 removed lines

@@ -4,7 +4,7 @@ 
  *
  */
 if ( ! defined( 'ABSPATH' ) ) {
-	exit;
+    exit;
 }
 
 /**
@@ -14,163 +14,163 @@ 
  */
 class GetPaid_Payment_Form_Data_Store extends GetPaid_Data_Store_WP {
 
-	/**
-	 * Data stored in meta keys, but not considered "meta" for a form.
-	 *
-	 * @since 1.0.19
-	 * @var array
-	 */
-	protected $internal_meta_keys = array(
-		'wpinv_form_elements',
-		'wpinv_form_items',
-		'wpinv_form_earned',
-		'wpinv_form_refunded',
-		'wpinv_form_cancelled',
-		'wpinv_form_failed'
-	);
-
-	/**
-	 * A map of meta keys to data props.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @var array
-	 */
-	protected $meta_key_to_props = array(
-		'wpinv_form_elements'  => 'elements',
-		'wpinv_form_items'     => 'items',
-		'wpinv_form_earned'    => 'earned',
-		'wpinv_form_refunded'  => 'refunded',
-		'wpinv_form_cancelled' => 'cancelled',
-		'wpinv_form_failed'    => 'failed',
-	);
-
-	/*
+    /**
+     * Data stored in meta keys, but not considered "meta" for a form.
+     *
+     * @since 1.0.19
+     * @var array
+     */
+    protected $internal_meta_keys = array(
+        'wpinv_form_elements',
+        'wpinv_form_items',
+        'wpinv_form_earned',
+        'wpinv_form_refunded',
+        'wpinv_form_cancelled',
+        'wpinv_form_failed'
+    );
+
+    /**
+     * A map of meta keys to data props.
+     *
+     * @since 1.0.19
+     *
+     * @var array
+     */
+    protected $meta_key_to_props = array(
+        'wpinv_form_elements'  => 'elements',
+        'wpinv_form_items'     => 'items',
+        'wpinv_form_earned'    => 'earned',
+        'wpinv_form_refunded'  => 'refunded',
+        'wpinv_form_cancelled' => 'cancelled',
+        'wpinv_form_failed'    => 'failed',
+    );
+
+    /*
 	|--------------------------------------------------------------------------
 	| CRUD Methods
 	|--------------------------------------------------------------------------
 	*/
 
-	/**
-	 * Method to create a new form in the database.
-	 *
-	 * @param GetPaid_Payment_Form $form Form object.
-	 */
-	public function create( &$form ) {
-		$form->set_version( WPINV_VERSION );
-		$form->set_date_created( current_time('mysql') );
-
-		// Create a new post.
-		$id = wp_insert_post(
-			apply_filters(
-				'getpaid_new_payment_form_data',
-				array(
-					'post_date'     => $form->get_date_created( 'edit' ),
-					'post_type'     => 'wpi_payment_form',
-					'post_status'   => $this->get_post_status( $form ),
-					'ping_status'   => 'closed',
-					'post_author'   => $form->get_author( 'edit' ),
-					'post_title'    => $form->get_name( 'edit' ),
-				)
-			),
-			true
-		);
-
-		if ( $id && ! is_wp_error( $id ) ) {
-			$form->set_id( $id );
-			$this->update_post_meta( $form );
-			$form->save_meta_data();
-			$form->apply_changes();
-			$this->clear_caches( $form );
-			return true;
-		}
-
-		if ( is_wp_error( $id ) ) {
-			$form->last_error = $id->get_error_message();
-		}
-
-		return false;
-	}
-
-	/**
-	 * Method to read a form from the database.
-	 *
-	 * @param GetPaid_Payment_Form $form Form object.
-	 *
-	 */
-	public function read( &$form ) {
-
-		$form->set_defaults();
-		$form_object = get_post( $form->get_id() );
-
-		if ( ! $form->get_id() || ! $form_object || $form_object->post_type != 'wpi_payment_form' ) {
-			$form->last_error = __( 'Invalid form.', 'invoicing' );
-			return false;
-		}
-
-		$form->set_props(
-			array(
-				'date_created'  => 0 < $form_object->post_date_gmt ? $form_object->post_date_gmt : null,
-				'date_modified' => 0 < $form_object->post_modified_gmt ? $form_object->post_modified_gmt : null,
-				'status'        => $form_object->post_status,
-				'name'          => $form_object->post_title,
-				'author'        => $form_object->post_author,
-			)
-		);
-
-		$this->read_object_data( $form, $form_object );
-		$form->read_meta_data();
-		$form->set_object_read( true );
-
-	}
-
-	/**
-	 * Method to update a form in the database.
-	 *
-	 * @param GetPaid_Payment_Form $form Form object.
-	 */
-	public function update( &$form ) {
-		$form->save_meta_data();
-		$form->set_version( WPINV_VERSION );
-
-		if ( null === $form->get_date_created( 'edit' ) ) {
-			$form->set_date_created(  current_time('mysql') );
-		}
-
-		$changes = $form->get_changes();
-
-		// Only update the post when the post data changes.
-		if ( array_intersect( array( 'date_created', 'date_modified', 'status', 'name', 'author' ), array_keys( $changes ) ) ) {
-			$post_data = array(
-				'post_date'         => $form->get_date_created( 'edit' ),
-				'post_status'       => $form->get_status( 'edit' ),
-				'post_title'        => $form->get_name( 'edit' ),
-				'post_author'       => $form->get_author( 'edit' ),
-				'post_modified'     => $form->get_date_modified( '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' => $form->get_id() ) );
-				clean_post_cache( $form->get_id() );
-			} else {
-				wp_update_post( array_merge( array( 'ID' => $form->get_id() ), $post_data ) );
-			}
-			$form->read_meta_data( true ); // Refresh internal meta data, in case things were hooked into `save_post` or another WP hook.
-		}
-		$this->update_post_meta( $form );
-		$form->apply_changes();
-		$this->clear_caches( $form );
-	}
-
-	/*
+    /**
+     * Method to create a new form in the database.
+     *
+     * @param GetPaid_Payment_Form $form Form object.
+     */
+    public function create( &$form ) {
+        $form->set_version( WPINV_VERSION );
+        $form->set_date_created( current_time('mysql') );
+
+        // Create a new post.
+        $id = wp_insert_post(
+            apply_filters(
+                'getpaid_new_payment_form_data',
+                array(
+                    'post_date'     => $form->get_date_created( 'edit' ),
+                    'post_type'     => 'wpi_payment_form',
+                    'post_status'   => $this->get_post_status( $form ),
+                    'ping_status'   => 'closed',
+                    'post_author'   => $form->get_author( 'edit' ),
+                    'post_title'    => $form->get_name( 'edit' ),
+                )
+            ),
+            true
+        );
+
+        if ( $id && ! is_wp_error( $id ) ) {
+            $form->set_id( $id );
+            $this->update_post_meta( $form );
+            $form->save_meta_data();
+            $form->apply_changes();
+            $this->clear_caches( $form );
+            return true;
+        }
+
+        if ( is_wp_error( $id ) ) {
+            $form->last_error = $id->get_error_message();
+        }
+
+        return false;
+    }
+
+    /**
+     * Method to read a form from the database.
+     *
+     * @param GetPaid_Payment_Form $form Form object.
+     *
+     */
+    public function read( &$form ) {
+
+        $form->set_defaults();
+        $form_object = get_post( $form->get_id() );
+
+        if ( ! $form->get_id() || ! $form_object || $form_object->post_type != 'wpi_payment_form' ) {
+            $form->last_error = __( 'Invalid form.', 'invoicing' );
+            return false;
+        }
+
+        $form->set_props(
+            array(
+                'date_created'  => 0 < $form_object->post_date_gmt ? $form_object->post_date_gmt : null,
+                'date_modified' => 0 < $form_object->post_modified_gmt ? $form_object->post_modified_gmt : null,
+                'status'        => $form_object->post_status,
+                'name'          => $form_object->post_title,
+                'author'        => $form_object->post_author,
+            )
+        );
+
+        $this->read_object_data( $form, $form_object );
+        $form->read_meta_data();
+        $form->set_object_read( true );
+
+    }
+
+    /**
+     * Method to update a form in the database.
+     *
+     * @param GetPaid_Payment_Form $form Form object.
+     */
+    public function update( &$form ) {
+        $form->save_meta_data();
+        $form->set_version( WPINV_VERSION );
+
+        if ( null === $form->get_date_created( 'edit' ) ) {
+            $form->set_date_created(  current_time('mysql') );
+        }
+
+        $changes = $form->get_changes();
+
+        // Only update the post when the post data changes.
+        if ( array_intersect( array( 'date_created', 'date_modified', 'status', 'name', 'author' ), array_keys( $changes ) ) ) {
+            $post_data = array(
+                'post_date'         => $form->get_date_created( 'edit' ),
+                'post_status'       => $form->get_status( 'edit' ),
+                'post_title'        => $form->get_name( 'edit' ),
+                'post_author'       => $form->get_author( 'edit' ),
+                'post_modified'     => $form->get_date_modified( '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' => $form->get_id() ) );
+                clean_post_cache( $form->get_id() );
+            } else {
+                wp_update_post( array_merge( array( 'ID' => $form->get_id() ), $post_data ) );
+            }
+            $form->read_meta_data( true ); // Refresh internal meta data, in case things were hooked into `save_post` or another WP hook.
+        }
+        $this->update_post_meta( $form );
+        $form->apply_changes();
+        $this->clear_caches( $form );
+    }
+
+    /*
 	|--------------------------------------------------------------------------
 	| Additional Methods
 	|--------------------------------------------------------------------------

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

Indentation +807 added lines, -807 removed lines

@@ -9,7 +9,7 @@ 
  */
 
 if ( ! defined( 'ABSPATH' ) ) {
-	exit;
+    exit;
 }
 
 /**
@@ -21,814 +21,814 @@ 
  */
 abstract class GetPaid_Data {
 
-	/**
-	 * ID for this object.
-	 *
-	 * @since 1.0.19
-	 * @var int
-	 */
-	protected $id = 0;
-
-	/**
-	 * Core data for this object. Name value pairs (name + default value).
-	 *
-	 * @since 1.0.19
-	 * @var array
-	 */
-	protected $data = array();
-
-	/**
-	 * Core data changes for this object.
-	 *
-	 * @since 1.0.19
-	 * @var array
-	 */
-	protected $changes = array();
-
-	/**
-	 * This is false until the object is read from the DB.
-	 *
-	 * @since 1.0.19
-	 * @var bool
-	 */
-	protected $object_read = false;
-
-	/**
-	 * This is the name of this object type.
-	 *
-	 * @since 1.0.19
-	 * @var string
-	 */
-	protected $object_type = 'data';
-
-	/**
-	 * Extra data for this object. Name value pairs (name + default value).
-	 * Used as a standard way for sub classes (like item types) to add
-	 * additional information to an inherited class.
-	 *
-	 * @since 1.0.19
-	 * @var array
-	 */
-	protected $extra_data = array();
-
-	/**
-	 * Set to _data on construct so we can track and reset data if needed.
-	 *
-	 * @since 1.0.19
-	 * @var array
-	 */
-	protected $default_data = array();
-
-	/**
-	 * Contains a reference to the data store for this class.
-	 *
-	 * @since 1.0.19
-	 * @var GetPaid_Data_Store
-	 */
-	protected $data_store;
-
-	/**
-	 * Stores meta in cache for future reads.
-	 * A group must be set to to enable caching.
-	 *
-	 * @since 1.0.19
-	 * @var string
-	 */
-	protected $cache_group = '';
-
-	/**
-	 * Stores the last error.
-	 *
-	 * @since 1.0.19
-	 * @var string
-	 */
-	public $last_error = '';
-
-	/**
-	 * Stores additional meta data.
-	 *
-	 * @since 1.0.19
-	 * @var array
-	 */
-	protected $meta_data = null;
-
-	/**
-	 * Default constructor.
-	 *
-	 * @param int|object|array $read ID to load from the DB (optional) or already queried data.
-	 */
-	public function __construct( $read = 0 ) {
-		$this->data         = array_merge( $this->data, $this->extra_data );
-		$this->default_data = $this->data;
-	}
-
-	/**
-	 * Only store the object ID to avoid serializing the data object instance.
-	 *
-	 * @return array
-	 */
-	public function __sleep() {
-		return array( 'id' );
-	}
-
-	/**
-	 * Re-run the constructor with the object ID.
-	 *
-	 * If the object no longer exists, remove the ID.
-	 */
-	public function __wakeup() {
-		try {
-			$this->__construct( absint( $this->id ) );
-		} catch ( Exception $e ) {
-			$this->set_id( 0 );
-			$this->set_object_read( true );
-		}
-	}
-
-	/**
-	 * When the object is cloned, make sure meta is duplicated correctly.
-	 *
-	 * @since 1.0.19
-	 */
-	public function __clone() {
-		$this->maybe_read_meta_data();
-		if ( ! empty( $this->meta_data ) ) {
-			foreach ( $this->meta_data as $array_key => $meta ) {
-				$this->meta_data[ $array_key ] = clone $meta;
-				if ( ! empty( $meta->id ) ) {
-					$this->meta_data[ $array_key ]->id = null;
-				}
-			}
-		}
-	}
-
-	/**
-	 * Get the data store.
-	 *
-	 * @since  1.0.19
-	 * @return object
-	 */
-	public function get_data_store() {
-		return $this->data_store;
-	}
-
-	/**
-	 * Get the object type.
-	 *
-	 * @since  1.0.19
-	 * @return string
-	 */
-	public function get_object_type() {
-		return $this->object_type;
-	}
-
-	/**
-	 * Returns the unique ID for this object.
-	 *
-	 * @since  1.0.19
-	 * @return int
-	 */
-	public function get_id() {
-		return $this->id;
-	}
-
-	/**
-	 * Get form 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 );
-    }
-
-	/**
-	 * Delete an object, set the ID to 0, and return result.
-	 *
-	 * @since  1.0.19
-	 * @param  bool $force_delete Should the data be deleted permanently.
-	 * @return bool result
-	 */
-	public function delete( $force_delete = false ) {
-		if ( $this->data_store ) {
-			$this->data_store->delete( $this, array( 'force_delete' => $force_delete ) );
-			$this->set_id( 0 );
-			return true;
-		}
-		return false;
-	}
-
-	/**
-	 * Save should create or update based on object existence.
-	 *
-	 * @since  1.0.19
-	 * @return int
-	 */
-	public function save() {
-		if ( ! $this->data_store ) {
-			return $this->get_id();
-		}
-
-		/**
-		 * Trigger action before saving to the DB. Allows you to adjust object props before save.
-		 *
-		 * @param GetPaid_Data          $this The object being saved.
-		 * @param GetPaid_Data_Store_WP $data_store The data store persisting the data.
-		 */
-		do_action( 'getpaid_before_' . $this->object_type . '_object_save', $this, $this->data_store );
-
-		if ( $this->get_id() ) {
-			$this->data_store->update( $this );
-		} else {
-			$this->data_store->create( $this );
-		}
-
-		/**
-		 * Trigger action after saving to the DB.
-		 *
-		 * @param GetPaid_Data          $this The object being saved.
-		 * @param GetPaid_Data_Store_WP $data_store The data store persisting the data.
-		 */
-		do_action( 'getpaid_after_' . $this->object_type . '_object_save', $this, $this->data_store );
-
-		return $this->get_id();
-	}
-
-	/**
-	 * Change data to JSON format.
-	 *
-	 * @since  1.0.19
-	 * @return string Data in JSON format.
-	 */
-	public function __toString() {
-		return wp_json_encode( $this->get_data() );
-	}
-
-	/**
-	 * Returns all data for this object.
-	 *
-	 * @since  1.0.19
-	 * @return array
-	 */
-	public function get_data() {
-		return array_merge( array( 'id' => $this->get_id() ), $this->data, array( 'meta_data' => $this->get_meta_data() ) );
-	}
-
-	/**
-	 * Returns array of expected data keys for this object.
-	 *
-	 * @since   1.0.19
-	 * @return array
-	 */
-	public function get_data_keys() {
-		return array_keys( $this->data );
-	}
-
-	/**
-	 * Returns all "extra" data keys for an object (for sub objects like item types).
-	 *
-	 * @since  1.0.19
-	 * @return array
-	 */
-	public function get_extra_data_keys() {
-		return array_keys( $this->extra_data );
-	}
-
-	/**
-	 * Filter null meta values from array.
-	 *
-	 * @since  1.0.19
-	 * @param mixed $meta Meta value to check.
-	 * @return bool
-	 */
-	protected function filter_null_meta( $meta ) {
-		return ! is_null( $meta->value );
-	}
-
-	/**
-	 * Get All Meta Data.
-	 *
-	 * @since 1.0.19
-	 * @return array of objects.
-	 */
-	public function get_meta_data() {
-		$this->maybe_read_meta_data();
-		return array_values( array_filter( $this->meta_data, array( $this, 'filter_null_meta' ) ) );
-	}
-
-	/**
-	 * Check if the key is an internal one.
-	 *
-	 * @since  1.0.19
-	 * @param  string $key Key to check.
-	 * @return bool   true if it's an internal key, false otherwise
-	 */
-	protected function is_internal_meta_key( $key ) {
-		$internal_meta_key = ! empty( $key ) && $this->data_store && in_array( $key, $this->data_store->get_internal_meta_keys(), true );
-
-		if ( ! $internal_meta_key ) {
-			return false;
-		}
-
-		$has_setter_or_getter = is_callable( array( $this, 'set_' . $key ) ) || is_callable( array( $this, 'get_' . $key ) );
-
-		if ( ! $has_setter_or_getter ) {
-			return false;
-		}
-
-		/* translators: %s: $key Key to check */
-		getpaid_doing_it_wrong( __FUNCTION__, sprintf( __( 'Generic add/update/get meta methods should not be used for internal meta data, including "%s". Use getters and setters.', 'getpaid' ), $key ), '1.0.19' );
-
-		return true;
-	}
-
-	/**
-	 * Get Meta Data by Key.
-	 *
-	 * @since  1.0.19
-	 * @param  string $key Meta Key.
-	 * @param  bool   $single return first found meta with key, or all with $key.
-	 * @param  string $context What the value is for. Valid values are view and edit.
-	 * @return mixed
-	 */
-	public function get_meta( $key = '', $single = true, $context = 'view' ) {
-
-		// Check if this is an internal meta key.
-		if ( $this->is_internal_meta_key( $key ) ) {
-			$function = 'get_' . $key;
-
-			if ( is_callable( array( $this, $function ) ) ) {
-				return $this->{$function}();
-			}
-		}
-
-		// Read the meta data if not yet read.
-		$this->maybe_read_meta_data();
-		$meta_data  = $this->get_meta_data();
-		$array_keys = array_keys( wp_list_pluck( $meta_data, 'key' ), $key, true );
-		$value      = $single ? '' : array();
-
-		if ( ! empty( $array_keys ) ) {
-			// We don't use the $this->meta_data property directly here because we don't want meta with a null value (i.e. meta which has been deleted via $this->delete_meta_data()).
-			if ( $single ) {
-				$value = $meta_data[ current( $array_keys ) ]->value;
-			} else {
-				$value = array_intersect_key( $meta_data, array_flip( $array_keys ) );
-			}
-		}
-
-		if ( 'view' === $context ) {
-			$value = apply_filters( $this->get_hook_prefix() . $key, $value, $this );
-		}
-
-		return $value;
-	}
-
-	/**
-	 * See if meta data exists, since get_meta always returns a '' or array().
-	 *
-	 * @since  1.0.19
-	 * @param  string $key Meta Key.
-	 * @return boolean
-	 */
-	public function meta_exists( $key = '' ) {
-		$this->maybe_read_meta_data();
-		$array_keys = wp_list_pluck( $this->get_meta_data(), 'key' );
-		return in_array( $key, $array_keys, true );
-	}
-
-	/**
-	 * Set all meta data from array.
-	 *
-	 * @since 1.0.19
-	 * @param array $data Key/Value pairs.
-	 */
-	public function set_meta_data( $data ) {
-		if ( ! empty( $data ) && is_array( $data ) ) {
-			$this->maybe_read_meta_data();
-			foreach ( $data as $meta ) {
-				$meta = (array) $meta;
-				if ( isset( $meta['key'], $meta['value'], $meta['id'] ) ) {
-					$this->meta_data[] = new GetPaid_Meta_Data(
-						array(
-							'id'    => $meta['id'],
-							'key'   => $meta['key'],
-							'value' => $meta['value'],
-						)
-					);
-				}
-			}
-		}
-	}
-
-	/**
-	 * Add meta data.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @param string       $key Meta key.
-	 * @param string|array $value Meta value.
-	 * @param bool         $unique Should this be a unique key?.
-	 */
-	public function add_meta_data( $key, $value, $unique = false ) {
-		if ( $this->is_internal_meta_key( $key ) ) {
-			$function = 'set_' . $key;
-
-			if ( is_callable( array( $this, $function ) ) ) {
-				return $this->{$function}( $value );
-			}
-		}
-
-		$this->maybe_read_meta_data();
-		if ( $unique ) {
-			$this->delete_meta_data( $key );
-		}
-		$this->meta_data[] = new GetPaid_Meta_Data(
-			array(
-				'key'   => $key,
-				'value' => $value,
-			)
-		);
-	}
-
-	/**
-	 * Update meta data by key or ID, if provided.
-	 *
-	 * @since  1.0.19
-	 *
-	 * @param  string       $key Meta key.
-	 * @param  string|array $value Meta value.
-	 * @param  int          $meta_id Meta ID.
-	 */
-	public function update_meta_data( $key, $value, $meta_id = 0 ) {
-		if ( $this->is_internal_meta_key( $key ) ) {
-			$function = 'set_' . $key;
-
-			if ( is_callable( array( $this, $function ) ) ) {
-				return $this->{$function}( $value );
-			}
-		}
-
-		$this->maybe_read_meta_data();
-
-		$array_key = false;
-
-		if ( $meta_id ) {
-			$array_keys = array_keys( wp_list_pluck( $this->meta_data, 'id' ), $meta_id, true );
-			$array_key  = $array_keys ? current( $array_keys ) : false;
-		} else {
-			// Find matches by key.
-			$matches = array();
-			foreach ( $this->meta_data as $meta_data_array_key => $meta ) {
-				if ( $meta->key === $key ) {
-					$matches[] = $meta_data_array_key;
-				}
-			}
-
-			if ( ! empty( $matches ) ) {
-				// Set matches to null so only one key gets the new value.
-				foreach ( $matches as $meta_data_array_key ) {
-					$this->meta_data[ $meta_data_array_key ]->value = null;
-				}
-				$array_key = current( $matches );
-			}
-		}
-
-		if ( false !== $array_key ) {
-			$meta        = $this->meta_data[ $array_key ];
-			$meta->key   = $key;
-			$meta->value = $value;
-		} else {
-			$this->add_meta_data( $key, $value, true );
-		}
-	}
-
-	/**
-	 * Delete meta data.
-	 *
-	 * @since 1.0.19
-	 * @param string $key Meta key.
-	 */
-	public function delete_meta_data( $key ) {
-		$this->maybe_read_meta_data();
-		$array_keys = array_keys( wp_list_pluck( $this->meta_data, 'key' ), $key, true );
-
-		if ( $array_keys ) {
-			foreach ( $array_keys as $array_key ) {
-				$this->meta_data[ $array_key ]->value = null;
-			}
-		}
-	}
-
-	/**
-	 * Delete meta data.
-	 *
-	 * @since 1.0.19
-	 * @param int $mid Meta ID.
-	 */
-	public function delete_meta_data_by_mid( $mid ) {
-		$this->maybe_read_meta_data();
-		$array_keys = array_keys( wp_list_pluck( $this->meta_data, 'id' ), (int) $mid, true );
-
-		if ( $array_keys ) {
-			foreach ( $array_keys as $array_key ) {
-				$this->meta_data[ $array_key ]->value = null;
-			}
-		}
-	}
-
-	/**
-	 * Read meta data if null.
-	 *
-	 * @since 1.0.19
-	 */
-	protected function maybe_read_meta_data() {
-		if ( is_null( $this->meta_data ) ) {
-			$this->read_meta_data();
-		}
-	}
-
-	/**
-	 * Read Meta Data from the database. Ignore any internal properties.
-	 * Uses it's own caches because get_metadata does not provide meta_ids.
-	 *
-	 * @since 1.0.19
-	 * @param bool $force_read True to force a new DB read (and update cache).
-	 */
-	public function read_meta_data( $force_read = false ) {
-		$this->meta_data = array();
-		$cache_loaded    = false;
-
-		if ( ! $this->get_id() ) {
-			return;
-		}
-
-		if ( ! $this->data_store ) {
-			return;
-		}
-
-		if ( ! empty( $this->cache_group ) ) {
-			$cache_key = GetPaid_Cache_Helper::get_cache_prefix( $this->cache_group ) . GetPaid_Cache_Helper::get_cache_prefix( 'object_' . $this->get_id() ) . 'object_meta_' . $this->get_id();
-		}
-
-		if ( ! $force_read ) {
-			if ( ! empty( $this->cache_group ) ) {
-				$cached_meta  = wp_cache_get( $cache_key, $this->cache_group );
-				$cache_loaded = ! empty( $cached_meta );
-			}
-		}
-
-		$raw_meta_data = $cache_loaded ? $cached_meta : $this->data_store->read_meta( $this );
-		if ( $raw_meta_data ) {
-			foreach ( $raw_meta_data as $meta ) {
-				$this->meta_data[] = new GetPaid_Meta_Data(
-					array(
-						'id'    => (int) $meta->meta_id,
-						'key'   => $meta->meta_key,
-						'value' => maybe_unserialize( $meta->meta_value ),
-					)
-				);
-			}
-
-			if ( ! $cache_loaded && ! empty( $this->cache_group ) ) {
-				wp_cache_set( $cache_key, $raw_meta_data, $this->cache_group );
-			}
-		}
-	}
-
-	/**
-	 * Update Meta Data in the database.
-	 *
-	 * @since 1.0.19
-	 */
-	public function save_meta_data() {
-		if ( ! $this->data_store || is_null( $this->meta_data ) ) {
-			return;
-		}
-		foreach ( $this->meta_data as $array_key => $meta ) {
-			if ( is_null( $meta->value ) ) {
-				if ( ! empty( $meta->id ) ) {
-					$this->data_store->delete_meta( $this, $meta );
-					unset( $this->meta_data[ $array_key ] );
-				}
-			} elseif ( empty( $meta->id ) ) {
-				$meta->id = $this->data_store->add_meta( $this, $meta );
-				$meta->apply_changes();
-			} else {
-				if ( $meta->get_changes() ) {
-					$this->data_store->update_meta( $this, $meta );
-					$meta->apply_changes();
-				}
-			}
-		}
-		if ( ! empty( $this->cache_group ) ) {
-			$cache_key = GetPaid_Cache_Helper::get_cache_prefix( $this->cache_group ) . GetPaid_Cache_Helper::get_cache_prefix( 'object_' . $this->get_id() ) . 'object_meta_' . $this->get_id();
-			wp_cache_delete( $cache_key, $this->cache_group );
-		}
-	}
-
-	/**
-	 * Set ID.
-	 *
-	 * @since 1.0.19
-	 * @param int $id ID.
-	 */
-	public function set_id( $id ) {
-		$this->id = absint( $id );
-	}
-
-	/**
-	 * Sets item status.
-	 *
-	 * @since 1.0.19
-	 * @param  string $status New status.
-	 * @return array details of change.
-	 */
-	public function set_status( $status ) {
+    /**
+     * ID for this object.
+     *
+     * @since 1.0.19
+     * @var int
+     */
+    protected $id = 0;
+
+    /**
+     * Core data for this object. Name value pairs (name + default value).
+     *
+     * @since 1.0.19
+     * @var array
+     */
+    protected $data = array();
+
+    /**
+     * Core data changes for this object.
+     *
+     * @since 1.0.19
+     * @var array
+     */
+    protected $changes = array();
+
+    /**
+     * This is false until the object is read from the DB.
+     *
+     * @since 1.0.19
+     * @var bool
+     */
+    protected $object_read = false;
+
+    /**
+     * This is the name of this object type.
+     *
+     * @since 1.0.19
+     * @var string
+     */
+    protected $object_type = 'data';
+
+    /**
+     * Extra data for this object. Name value pairs (name + default value).
+     * Used as a standard way for sub classes (like item types) to add
+     * additional information to an inherited class.
+     *
+     * @since 1.0.19
+     * @var array
+     */
+    protected $extra_data = array();
+
+    /**
+     * Set to _data on construct so we can track and reset data if needed.
+     *
+     * @since 1.0.19
+     * @var array
+     */
+    protected $default_data = array();
+
+    /**
+     * Contains a reference to the data store for this class.
+     *
+     * @since 1.0.19
+     * @var GetPaid_Data_Store
+     */
+    protected $data_store;
+
+    /**
+     * Stores meta in cache for future reads.
+     * A group must be set to to enable caching.
+     *
+     * @since 1.0.19
+     * @var string
+     */
+    protected $cache_group = '';
+
+    /**
+     * Stores the last error.
+     *
+     * @since 1.0.19
+     * @var string
+     */
+    public $last_error = '';
+
+    /**
+     * Stores additional meta data.
+     *
+     * @since 1.0.19
+     * @var array
+     */
+    protected $meta_data = null;
+
+    /**
+     * Default constructor.
+     *
+     * @param int|object|array $read ID to load from the DB (optional) or already queried data.
+     */
+    public function __construct( $read = 0 ) {
+        $this->data         = array_merge( $this->data, $this->extra_data );
+        $this->default_data = $this->data;
+    }
+
+    /**
+     * Only store the object ID to avoid serializing the data object instance.
+     *
+     * @return array
+     */
+    public function __sleep() {
+        return array( 'id' );
+    }
+
+    /**
+     * Re-run the constructor with the object ID.
+     *
+     * If the object no longer exists, remove the ID.
+     */
+    public function __wakeup() {
+        try {
+            $this->__construct( absint( $this->id ) );
+        } catch ( Exception $e ) {
+            $this->set_id( 0 );
+            $this->set_object_read( true );
+        }
+    }
+
+    /**
+     * When the object is cloned, make sure meta is duplicated correctly.
+     *
+     * @since 1.0.19
+     */
+    public function __clone() {
+        $this->maybe_read_meta_data();
+        if ( ! empty( $this->meta_data ) ) {
+            foreach ( $this->meta_data as $array_key => $meta ) {
+                $this->meta_data[ $array_key ] = clone $meta;
+                if ( ! empty( $meta->id ) ) {
+                    $this->meta_data[ $array_key ]->id = null;
+                }
+            }
+        }
+    }
+
+    /**
+     * Get the data store.
+     *
+     * @since  1.0.19
+     * @return object
+     */
+    public function get_data_store() {
+        return $this->data_store;
+    }
+
+    /**
+     * Get the object type.
+     *
+     * @since  1.0.19
+     * @return string
+     */
+    public function get_object_type() {
+        return $this->object_type;
+    }
+
+    /**
+     * Returns the unique ID for this object.
+     *
+     * @since  1.0.19
+     * @return int
+     */
+    public function get_id() {
+        return $this->id;
+    }
+
+    /**
+     * Get form 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 );
+    }
+
+    /**
+     * Delete an object, set the ID to 0, and return result.
+     *
+     * @since  1.0.19
+     * @param  bool $force_delete Should the data be deleted permanently.
+     * @return bool result
+     */
+    public function delete( $force_delete = false ) {
+        if ( $this->data_store ) {
+            $this->data_store->delete( $this, array( 'force_delete' => $force_delete ) );
+            $this->set_id( 0 );
+            return true;
+        }
+        return false;
+    }
+
+    /**
+     * Save should create or update based on object existence.
+     *
+     * @since  1.0.19
+     * @return int
+     */
+    public function save() {
+        if ( ! $this->data_store ) {
+            return $this->get_id();
+        }
+
+        /**
+         * Trigger action before saving to the DB. Allows you to adjust object props before save.
+         *
+         * @param GetPaid_Data          $this The object being saved.
+         * @param GetPaid_Data_Store_WP $data_store The data store persisting the data.
+         */
+        do_action( 'getpaid_before_' . $this->object_type . '_object_save', $this, $this->data_store );
+
+        if ( $this->get_id() ) {
+            $this->data_store->update( $this );
+        } else {
+            $this->data_store->create( $this );
+        }
+
+        /**
+         * Trigger action after saving to the DB.
+         *
+         * @param GetPaid_Data          $this The object being saved.
+         * @param GetPaid_Data_Store_WP $data_store The data store persisting the data.
+         */
+        do_action( 'getpaid_after_' . $this->object_type . '_object_save', $this, $this->data_store );
+
+        return $this->get_id();
+    }
+
+    /**
+     * Change data to JSON format.
+     *
+     * @since  1.0.19
+     * @return string Data in JSON format.
+     */
+    public function __toString() {
+        return wp_json_encode( $this->get_data() );
+    }
+
+    /**
+     * Returns all data for this object.
+     *
+     * @since  1.0.19
+     * @return array
+     */
+    public function get_data() {
+        return array_merge( array( 'id' => $this->get_id() ), $this->data, array( 'meta_data' => $this->get_meta_data() ) );
+    }
+
+    /**
+     * Returns array of expected data keys for this object.
+     *
+     * @since   1.0.19
+     * @return array
+     */
+    public function get_data_keys() {
+        return array_keys( $this->data );
+    }
+
+    /**
+     * Returns all "extra" data keys for an object (for sub objects like item types).
+     *
+     * @since  1.0.19
+     * @return array
+     */
+    public function get_extra_data_keys() {
+        return array_keys( $this->extra_data );
+    }
+
+    /**
+     * Filter null meta values from array.
+     *
+     * @since  1.0.19
+     * @param mixed $meta Meta value to check.
+     * @return bool
+     */
+    protected function filter_null_meta( $meta ) {
+        return ! is_null( $meta->value );
+    }
+
+    /**
+     * Get All Meta Data.
+     *
+     * @since 1.0.19
+     * @return array of objects.
+     */
+    public function get_meta_data() {
+        $this->maybe_read_meta_data();
+        return array_values( array_filter( $this->meta_data, array( $this, 'filter_null_meta' ) ) );
+    }
+
+    /**
+     * Check if the key is an internal one.
+     *
+     * @since  1.0.19
+     * @param  string $key Key to check.
+     * @return bool   true if it's an internal key, false otherwise
+     */
+    protected function is_internal_meta_key( $key ) {
+        $internal_meta_key = ! empty( $key ) && $this->data_store && in_array( $key, $this->data_store->get_internal_meta_keys(), true );
+
+        if ( ! $internal_meta_key ) {
+            return false;
+        }
+
+        $has_setter_or_getter = is_callable( array( $this, 'set_' . $key ) ) || is_callable( array( $this, 'get_' . $key ) );
+
+        if ( ! $has_setter_or_getter ) {
+            return false;
+        }
+
+        /* translators: %s: $key Key to check */
+        getpaid_doing_it_wrong( __FUNCTION__, sprintf( __( 'Generic add/update/get meta methods should not be used for internal meta data, including "%s". Use getters and setters.', 'getpaid' ), $key ), '1.0.19' );
+
+        return true;
+    }
+
+    /**
+     * Get Meta Data by Key.
+     *
+     * @since  1.0.19
+     * @param  string $key Meta Key.
+     * @param  bool   $single return first found meta with key, or all with $key.
+     * @param  string $context What the value is for. Valid values are view and edit.
+     * @return mixed
+     */
+    public function get_meta( $key = '', $single = true, $context = 'view' ) {
+
+        // Check if this is an internal meta key.
+        if ( $this->is_internal_meta_key( $key ) ) {
+            $function = 'get_' . $key;
+
+            if ( is_callable( array( $this, $function ) ) ) {
+                return $this->{$function}();
+            }
+        }
+
+        // Read the meta data if not yet read.
+        $this->maybe_read_meta_data();
+        $meta_data  = $this->get_meta_data();
+        $array_keys = array_keys( wp_list_pluck( $meta_data, 'key' ), $key, true );
+        $value      = $single ? '' : array();
+
+        if ( ! empty( $array_keys ) ) {
+            // We don't use the $this->meta_data property directly here because we don't want meta with a null value (i.e. meta which has been deleted via $this->delete_meta_data()).
+            if ( $single ) {
+                $value = $meta_data[ current( $array_keys ) ]->value;
+            } else {
+                $value = array_intersect_key( $meta_data, array_flip( $array_keys ) );
+            }
+        }
+
+        if ( 'view' === $context ) {
+            $value = apply_filters( $this->get_hook_prefix() . $key, $value, $this );
+        }
+
+        return $value;
+    }
+
+    /**
+     * See if meta data exists, since get_meta always returns a '' or array().
+     *
+     * @since  1.0.19
+     * @param  string $key Meta Key.
+     * @return boolean
+     */
+    public function meta_exists( $key = '' ) {
+        $this->maybe_read_meta_data();
+        $array_keys = wp_list_pluck( $this->get_meta_data(), 'key' );
+        return in_array( $key, $array_keys, true );
+    }
+
+    /**
+     * Set all meta data from array.
+     *
+     * @since 1.0.19
+     * @param array $data Key/Value pairs.
+     */
+    public function set_meta_data( $data ) {
+        if ( ! empty( $data ) && is_array( $data ) ) {
+            $this->maybe_read_meta_data();
+            foreach ( $data as $meta ) {
+                $meta = (array) $meta;
+                if ( isset( $meta['key'], $meta['value'], $meta['id'] ) ) {
+                    $this->meta_data[] = new GetPaid_Meta_Data(
+                        array(
+                            'id'    => $meta['id'],
+                            'key'   => $meta['key'],
+                            'value' => $meta['value'],
+                        )
+                    );
+                }
+            }
+        }
+    }
+
+    /**
+     * Add meta data.
+     *
+     * @since 1.0.19
+     *
+     * @param string       $key Meta key.
+     * @param string|array $value Meta value.
+     * @param bool         $unique Should this be a unique key?.
+     */
+    public function add_meta_data( $key, $value, $unique = false ) {
+        if ( $this->is_internal_meta_key( $key ) ) {
+            $function = 'set_' . $key;
+
+            if ( is_callable( array( $this, $function ) ) ) {
+                return $this->{$function}( $value );
+            }
+        }
+
+        $this->maybe_read_meta_data();
+        if ( $unique ) {
+            $this->delete_meta_data( $key );
+        }
+        $this->meta_data[] = new GetPaid_Meta_Data(
+            array(
+                'key'   => $key,
+                'value' => $value,
+            )
+        );
+    }
+
+    /**
+     * Update meta data by key or ID, if provided.
+     *
+     * @since  1.0.19
+     *
+     * @param  string       $key Meta key.
+     * @param  string|array $value Meta value.
+     * @param  int          $meta_id Meta ID.
+     */
+    public function update_meta_data( $key, $value, $meta_id = 0 ) {
+        if ( $this->is_internal_meta_key( $key ) ) {
+            $function = 'set_' . $key;
+
+            if ( is_callable( array( $this, $function ) ) ) {
+                return $this->{$function}( $value );
+            }
+        }
+
+        $this->maybe_read_meta_data();
+
+        $array_key = false;
+
+        if ( $meta_id ) {
+            $array_keys = array_keys( wp_list_pluck( $this->meta_data, 'id' ), $meta_id, true );
+            $array_key  = $array_keys ? current( $array_keys ) : false;
+        } else {
+            // Find matches by key.
+            $matches = array();
+            foreach ( $this->meta_data as $meta_data_array_key => $meta ) {
+                if ( $meta->key === $key ) {
+                    $matches[] = $meta_data_array_key;
+                }
+            }
+
+            if ( ! empty( $matches ) ) {
+                // Set matches to null so only one key gets the new value.
+                foreach ( $matches as $meta_data_array_key ) {
+                    $this->meta_data[ $meta_data_array_key ]->value = null;
+                }
+                $array_key = current( $matches );
+            }
+        }
+
+        if ( false !== $array_key ) {
+            $meta        = $this->meta_data[ $array_key ];
+            $meta->key   = $key;
+            $meta->value = $value;
+        } else {
+            $this->add_meta_data( $key, $value, true );
+        }
+    }
+
+    /**
+     * Delete meta data.
+     *
+     * @since 1.0.19
+     * @param string $key Meta key.
+     */
+    public function delete_meta_data( $key ) {
+        $this->maybe_read_meta_data();
+        $array_keys = array_keys( wp_list_pluck( $this->meta_data, 'key' ), $key, true );
+
+        if ( $array_keys ) {
+            foreach ( $array_keys as $array_key ) {
+                $this->meta_data[ $array_key ]->value = null;
+            }
+        }
+    }
+
+    /**
+     * Delete meta data.
+     *
+     * @since 1.0.19
+     * @param int $mid Meta ID.
+     */
+    public function delete_meta_data_by_mid( $mid ) {
+        $this->maybe_read_meta_data();
+        $array_keys = array_keys( wp_list_pluck( $this->meta_data, 'id' ), (int) $mid, true );
+
+        if ( $array_keys ) {
+            foreach ( $array_keys as $array_key ) {
+                $this->meta_data[ $array_key ]->value = null;
+            }
+        }
+    }
+
+    /**
+     * Read meta data if null.
+     *
+     * @since 1.0.19
+     */
+    protected function maybe_read_meta_data() {
+        if ( is_null( $this->meta_data ) ) {
+            $this->read_meta_data();
+        }
+    }
+
+    /**
+     * Read Meta Data from the database. Ignore any internal properties.
+     * Uses it's own caches because get_metadata does not provide meta_ids.
+     *
+     * @since 1.0.19
+     * @param bool $force_read True to force a new DB read (and update cache).
+     */
+    public function read_meta_data( $force_read = false ) {
+        $this->meta_data = array();
+        $cache_loaded    = false;
+
+        if ( ! $this->get_id() ) {
+            return;
+        }
+
+        if ( ! $this->data_store ) {
+            return;
+        }
+
+        if ( ! empty( $this->cache_group ) ) {
+            $cache_key = GetPaid_Cache_Helper::get_cache_prefix( $this->cache_group ) . GetPaid_Cache_Helper::get_cache_prefix( 'object_' . $this->get_id() ) . 'object_meta_' . $this->get_id();
+        }
+
+        if ( ! $force_read ) {
+            if ( ! empty( $this->cache_group ) ) {
+                $cached_meta  = wp_cache_get( $cache_key, $this->cache_group );
+                $cache_loaded = ! empty( $cached_meta );
+            }
+        }
+
+        $raw_meta_data = $cache_loaded ? $cached_meta : $this->data_store->read_meta( $this );
+        if ( $raw_meta_data ) {
+            foreach ( $raw_meta_data as $meta ) {
+                $this->meta_data[] = new GetPaid_Meta_Data(
+                    array(
+                        'id'    => (int) $meta->meta_id,
+                        'key'   => $meta->meta_key,
+                        'value' => maybe_unserialize( $meta->meta_value ),
+                    )
+                );
+            }
+
+            if ( ! $cache_loaded && ! empty( $this->cache_group ) ) {
+                wp_cache_set( $cache_key, $raw_meta_data, $this->cache_group );
+            }
+        }
+    }
+
+    /**
+     * Update Meta Data in the database.
+     *
+     * @since 1.0.19
+     */
+    public function save_meta_data() {
+        if ( ! $this->data_store || is_null( $this->meta_data ) ) {
+            return;
+        }
+        foreach ( $this->meta_data as $array_key => $meta ) {
+            if ( is_null( $meta->value ) ) {
+                if ( ! empty( $meta->id ) ) {
+                    $this->data_store->delete_meta( $this, $meta );
+                    unset( $this->meta_data[ $array_key ] );
+                }
+            } elseif ( empty( $meta->id ) ) {
+                $meta->id = $this->data_store->add_meta( $this, $meta );
+                $meta->apply_changes();
+            } else {
+                if ( $meta->get_changes() ) {
+                    $this->data_store->update_meta( $this, $meta );
+                    $meta->apply_changes();
+                }
+            }
+        }
+        if ( ! empty( $this->cache_group ) ) {
+            $cache_key = GetPaid_Cache_Helper::get_cache_prefix( $this->cache_group ) . GetPaid_Cache_Helper::get_cache_prefix( 'object_' . $this->get_id() ) . 'object_meta_' . $this->get_id();
+            wp_cache_delete( $cache_key, $this->cache_group );
+        }
+    }
+
+    /**
+     * Set ID.
+     *
+     * @since 1.0.19
+     * @param int $id ID.
+     */
+    public function set_id( $id ) {
+        $this->id = absint( $id );
+    }
+
+    /**
+     * 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,
-		);
-    }
-
-	/**
-	 * Set all props to default values.
-	 *
-	 * @since 1.0.19
-	 */
-	public function set_defaults() {
-		$this->data    = $this->default_data;
-		$this->changes = array();
-		$this->set_object_read( false );
-	}
-
-	/**
-	 * Set object read property.
-	 *
-	 * @since 1.0.19
-	 * @param boolean $read Should read?.
-	 */
-	public function set_object_read( $read = true ) {
-		$this->object_read = (bool) $read;
-	}
-
-	/**
-	 * Get object read property.
-	 *
-	 * @since  1.0.19
-	 * @return boolean
-	 */
-	public function get_object_read() {
-		return (bool) $this->object_read;
-	}
-
-	/**
-	 * Set a collection of props in one go, collect any errors, and return the result.
-	 * Only sets using public methods.
-	 *
-	 * @since  1.0.19
-	 *
-	 * @param array  $props Key value pairs to set. Key is the prop and should map to a setter function name.
-	 * @param string $context In what context to run this.
-	 *
-	 * @return bool|WP_Error
-	 */
-	public function set_props( $props, $context = 'set' ) {
-		$errors = false;
-
-		foreach ( $props as $prop => $value ) {
-			try {
-				/**
-				 * Checks if the prop being set is allowed, and the value is not null.
-				 */
-				if ( is_null( $value ) || in_array( $prop, array( 'prop', 'date_prop', 'meta_data' ), true ) ) {
-					continue;
-				}
-				$setter = "set_$prop";
-
-				if ( is_callable( array( $this, $setter ) ) ) {
-					$this->{$setter}( $value );
-				}
-			} catch ( Exception $e ) {
-				if ( ! $errors ) {
-					$errors = new WP_Error();
-				}
-				$errors->add( $e->getCode(), $e->getMessage() );
-				$this->last_error = $e->getMessage();
-			}
-		}
-
-		return $errors && count( $errors->get_error_codes() ) ? $errors : true;
-	}
-
-	/**
-	 * Sets a prop for a setter method.
-	 *
-	 * This stores changes in a special array so we can track what needs saving
-	 * the the DB later.
-	 *
-	 * @since 1.0.19
-	 * @param string $prop Name of prop to set.
-	 * @param mixed  $value Value of the prop.
-	 */
-	protected function set_prop( $prop, $value ) {
-		if ( array_key_exists( $prop, $this->data ) ) {
-			if ( true === $this->object_read ) {
-				if ( $value !== $this->data[ $prop ] || array_key_exists( $prop, $this->changes ) ) {
-					$this->changes[ $prop ] = $value;
-				}
-			} else {
-				$this->data[ $prop ] = $value;
-			}
-		}
-	}
-
-	/**
-	 * Return data changes only.
-	 *
-	 * @since 1.0.19
-	 * @return array
-	 */
-	public function get_changes() {
-		return $this->changes;
-	}
-
-	/**
-	 * Merge changes with data and clear.
-	 *
-	 * @since 1.0.19
-	 */
-	public function apply_changes() {
-		$this->data    = array_replace_recursive( $this->data, $this->changes );
-		$this->changes = array();
-	}
-
-	/**
-	 * Prefix for action and filter hooks on data.
-	 *
-	 * @since  1.0.19
-	 * @return string
-	 */
-	protected function get_hook_prefix() {
-		return 'wpinv_get_' . $this->object_type . '_';
-	}
-
-	/**
-	 * Gets a prop for a getter method.
-	 *
-	 * Gets the value from either current pending changes, or the data itself.
-	 * Context controls what happens to the value before it's returned.
-	 *
-	 * @since  1.0.19
-	 * @param  string $prop Name of prop to get.
-	 * @param  string $context What the value is for. Valid values are view and edit.
-	 * @return mixed
-	 */
-	protected function get_prop( $prop, $context = 'view' ) {
-		$value = null;
-
-		if ( array_key_exists( $prop, $this->data ) ) {
-			$value = array_key_exists( $prop, $this->changes ) ? $this->changes[ $prop ] : $this->data[ $prop ];
-
-			if ( 'view' === $context ) {
-				$value = apply_filters( $this->get_hook_prefix() . $prop, $value, $this );
-			}
-		}
-
-		return $value;
-	}
-
-	/**
-	 * Sets a date prop whilst handling formatting and datetime objects.
-	 *
-	 * @since 1.0.19
-	 * @param string         $prop Name of prop to set.
-	 * @param string|integer $value Value of the prop.
-	 */
-	protected function set_date_prop( $prop, $value ) {
-
-		if ( empty( $value ) ) {
-			$this->set_prop( $prop, null );
-			return;
-		}
-		$this->set_prop( $prop, $value );
-
-	}
-
-	/**
-	 * When invalid data is found, throw an exception unless reading from the DB.
-	 *
-	 * @throws Exception Data Exception.
-	 * @since 1.0.19
-	 * @param string $code             Error code.
-	 * @param string $message          Error message.
-	 */
-	protected function error( $code, $message ) {
-		throw new Exception( $message, $code );
-	}
+        return array(
+            'from' => $old_status,
+            'to'   => $status,
+        );
+    }
+
+    /**
+     * Set all props to default values.
+     *
+     * @since 1.0.19
+     */
+    public function set_defaults() {
+        $this->data    = $this->default_data;
+        $this->changes = array();
+        $this->set_object_read( false );
+    }
+
+    /**
+     * Set object read property.
+     *
+     * @since 1.0.19
+     * @param boolean $read Should read?.
+     */
+    public function set_object_read( $read = true ) {
+        $this->object_read = (bool) $read;
+    }
+
+    /**
+     * Get object read property.
+     *
+     * @since  1.0.19
+     * @return boolean
+     */
+    public function get_object_read() {
+        return (bool) $this->object_read;
+    }
+
+    /**
+     * Set a collection of props in one go, collect any errors, and return the result.
+     * Only sets using public methods.
+     *
+     * @since  1.0.19
+     *
+     * @param array  $props Key value pairs to set. Key is the prop and should map to a setter function name.
+     * @param string $context In what context to run this.
+     *
+     * @return bool|WP_Error
+     */
+    public function set_props( $props, $context = 'set' ) {
+        $errors = false;
+
+        foreach ( $props as $prop => $value ) {
+            try {
+                /**
+                 * Checks if the prop being set is allowed, and the value is not null.
+                 */
+                if ( is_null( $value ) || in_array( $prop, array( 'prop', 'date_prop', 'meta_data' ), true ) ) {
+                    continue;
+                }
+                $setter = "set_$prop";
+
+                if ( is_callable( array( $this, $setter ) ) ) {
+                    $this->{$setter}( $value );
+                }
+            } catch ( Exception $e ) {
+                if ( ! $errors ) {
+                    $errors = new WP_Error();
+                }
+                $errors->add( $e->getCode(), $e->getMessage() );
+                $this->last_error = $e->getMessage();
+            }
+        }
+
+        return $errors && count( $errors->get_error_codes() ) ? $errors : true;
+    }
+
+    /**
+     * Sets a prop for a setter method.
+     *
+     * This stores changes in a special array so we can track what needs saving
+     * the the DB later.
+     *
+     * @since 1.0.19
+     * @param string $prop Name of prop to set.
+     * @param mixed  $value Value of the prop.
+     */
+    protected function set_prop( $prop, $value ) {
+        if ( array_key_exists( $prop, $this->data ) ) {
+            if ( true === $this->object_read ) {
+                if ( $value !== $this->data[ $prop ] || array_key_exists( $prop, $this->changes ) ) {
+                    $this->changes[ $prop ] = $value;
+                }
+            } else {
+                $this->data[ $prop ] = $value;
+            }
+        }
+    }
+
+    /**
+     * Return data changes only.
+     *
+     * @since 1.0.19
+     * @return array
+     */
+    public function get_changes() {
+        return $this->changes;
+    }
+
+    /**
+     * Merge changes with data and clear.
+     *
+     * @since 1.0.19
+     */
+    public function apply_changes() {
+        $this->data    = array_replace_recursive( $this->data, $this->changes );
+        $this->changes = array();
+    }
+
+    /**
+     * Prefix for action and filter hooks on data.
+     *
+     * @since  1.0.19
+     * @return string
+     */
+    protected function get_hook_prefix() {
+        return 'wpinv_get_' . $this->object_type . '_';
+    }
+
+    /**
+     * Gets a prop for a getter method.
+     *
+     * Gets the value from either current pending changes, or the data itself.
+     * Context controls what happens to the value before it's returned.
+     *
+     * @since  1.0.19
+     * @param  string $prop Name of prop to get.
+     * @param  string $context What the value is for. Valid values are view and edit.
+     * @return mixed
+     */
+    protected function get_prop( $prop, $context = 'view' ) {
+        $value = null;
+
+        if ( array_key_exists( $prop, $this->data ) ) {
+            $value = array_key_exists( $prop, $this->changes ) ? $this->changes[ $prop ] : $this->data[ $prop ];
+
+            if ( 'view' === $context ) {
+                $value = apply_filters( $this->get_hook_prefix() . $prop, $value, $this );
+            }
+        }
+
+        return $value;
+    }
+
+    /**
+     * Sets a date prop whilst handling formatting and datetime objects.
+     *
+     * @since 1.0.19
+     * @param string         $prop Name of prop to set.
+     * @param string|integer $value Value of the prop.
+     */
+    protected function set_date_prop( $prop, $value ) {
+
+        if ( empty( $value ) ) {
+            $this->set_prop( $prop, null );
+            return;
+        }
+        $this->set_prop( $prop, $value );
+
+    }
+
+    /**
+     * When invalid data is found, throw an exception unless reading from the DB.
+     *
+     * @throws Exception Data Exception.
+     * @since 1.0.19
+     * @param string $code             Error code.
+     * @param string $message          Error message.
+     */
+    protected function error( $code, $message ) {
+        throw new Exception( $message, $code );
+    }
 }

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

Indentation +333 added lines, -333 removed lines

@@ -14,341 +14,341 @@
  */
 class GetPaid_Data_Store_WP {
 
-	/**
-	 * Meta type. This should match up with
-	 * the types available at https://developer.wordpress.org/reference/functions/add_metadata/.
-	 * WP defines 'post', 'user', 'comment', and 'term'.
-	 *
-	 * @var string
-	 */
-	protected $meta_type = 'post';
-
-	/**
-	 * This only needs set if you are using a custom metadata type.
-	 *
-	 * @var string
-	 */
-	protected $object_id_field_for_meta = '';
-
-	/**
-	 * Data stored in meta keys, but not considered "meta" for an object.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @var array
-	 */
-	protected $internal_meta_keys = array();
-
-	/**
-	 * Meta data which should exist in the DB, even if empty.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @var array
-	 */
-	protected $must_exist_meta_keys = array();
-
-	/**
-	 * A map of meta keys to data props.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @var array
-	 */
-	protected $meta_key_to_props = array();
-
-	/**
-	 * Returns an array of meta for an object.
-	 *
-	 * @since  1.0.19
-	 * @param  GetPaid_Data $object GetPaid_Data object.
-	 * @return array
-	 */
-	public function read_meta( &$object ) {
-		global $wpdb;
-		$db_info       = $this->get_db_info();
-		$raw_meta_data = $wpdb->get_results(
-			$wpdb->prepare(
-				"SELECT {$db_info['meta_id_field']} as meta_id, meta_key, meta_value
+    /**
+     * Meta type. This should match up with
+     * the types available at https://developer.wordpress.org/reference/functions/add_metadata/.
+     * WP defines 'post', 'user', 'comment', and 'term'.
+     *
+     * @var string
+     */
+    protected $meta_type = 'post';
+
+    /**
+     * This only needs set if you are using a custom metadata type.
+     *
+     * @var string
+     */
+    protected $object_id_field_for_meta = '';
+
+    /**
+     * Data stored in meta keys, but not considered "meta" for an object.
+     *
+     * @since 1.0.19
+     *
+     * @var array
+     */
+    protected $internal_meta_keys = array();
+
+    /**
+     * Meta data which should exist in the DB, even if empty.
+     *
+     * @since 1.0.19
+     *
+     * @var array
+     */
+    protected $must_exist_meta_keys = array();
+
+    /**
+     * A map of meta keys to data props.
+     *
+     * @since 1.0.19
+     *
+     * @var array
+     */
+    protected $meta_key_to_props = array();
+
+    /**
+     * Returns an array of meta for an object.
+     *
+     * @since  1.0.19
+     * @param  GetPaid_Data $object GetPaid_Data object.
+     * @return array
+     */
+    public function read_meta( &$object ) {
+        global $wpdb;
+        $db_info       = $this->get_db_info();
+        $raw_meta_data = $wpdb->get_results(
+            $wpdb->prepare(
+                "SELECT {$db_info['meta_id_field']} as meta_id, meta_key, meta_value
 				FROM {$db_info['table']}
 				WHERE {$db_info['object_id_field']} = %d
 				ORDER BY {$db_info['meta_id_field']}",
-				$object->get_id()
-			)
-		);
-
-		$this->internal_meta_keys = array_merge( array_map( array( $this, 'prefix_key' ), $object->get_data_keys() ), $this->internal_meta_keys );
-		$meta_data                = array_filter( $raw_meta_data, array( $this, 'exclude_internal_meta_keys' ) );
-		return apply_filters( "getpaid_data_store_wp_{$this->meta_type}_read_meta", $meta_data, $object, $this );
-	}
-
-	/**
-	 * Deletes meta based on meta ID.
-	 *
-	 * @since  1.0.19
-	 * @param  GetPaid_Data  $object GetPaid_Data object.
-	 * @param  stdClass $meta (containing at least ->id).
-	 */
-	public function delete_meta( &$object, $meta ) {
-		delete_metadata_by_mid( $this->meta_type, $meta->id );
-	}
-
-	/**
-	 * Add new piece of meta.
-	 *
-	 * @since  1.0.19
-	 * @param  GetPaid_Data  $object GetPaid_Data object.
-	 * @param  stdClass $meta (containing ->key and ->value).
-	 * @return int meta ID
-	 */
-	public function add_meta( &$object, $meta ) {
-		return add_metadata( $this->meta_type, $object->get_id(), $meta->key, is_string( $meta->value ) ? wp_slash( $meta->value ) : $meta->value, false );
-	}
-
-	/**
-	 * Update meta.
-	 *
-	 * @since  1.0.19
-	 * @param  GetPaid_Data  $object GetPaid_Data object.
-	 * @param  stdClass $meta (containing ->id, ->key and ->value).
-	 */
-	public function update_meta( &$object, $meta ) {
-		update_metadata_by_mid( $this->meta_type, $meta->id, $meta->value, $meta->key );
-	}
-
-	/**
-	 * Table structure is slightly different between meta types, this function will return what we need to know.
-	 *
-	 * @since  1.0.19
-	 * @return array Array elements: table, object_id_field, meta_id_field
-	 */
-	protected function get_db_info() {
-		global $wpdb;
-
-		$meta_id_field = 'meta_id'; // users table calls this umeta_id so we need to track this as well.
-		$table         = $wpdb->prefix;
-
-		// If we are dealing with a type of metadata that is not a core type, the table should be prefixed.
-		if ( ! in_array( $this->meta_type, array( 'post', 'user', 'comment', 'term' ), true ) ) {
-			$table .= 'getpaid_';
-		}
-
-		$table          .= $this->meta_type . 'meta';
-		$object_id_field = $this->meta_type . '_id';
-
-		// Figure out our field names.
-		if ( 'user' === $this->meta_type ) {
-			$meta_id_field = 'umeta_id';
-			$table         = $wpdb->usermeta;
-		}
-
-		if ( ! empty( $this->object_id_field_for_meta ) ) {
-			$object_id_field = $this->object_id_field_for_meta;
-		}
-
-		return array(
-			'table'           => $table,
-			'object_id_field' => $object_id_field,
-			'meta_id_field'   => $meta_id_field,
-		);
-	}
-
-	/**
-	 * Internal meta keys we don't want exposed as part of meta_data. This is in
-	 * addition to all data props with _ prefix.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @param string $key Prefix to be added to meta keys.
-	 * @return string
-	 */
-	protected function prefix_key( $key ) {
-		return '_' === substr( $key, 0, 1 ) ? $key : '_' . $key;
-	}
-
-	/**
-	 * Callback to remove unwanted meta data.
-	 *
-	 * @param object $meta Meta object to check if it should be excluded or not.
-	 * @return bool
-	 */
-	protected function exclude_internal_meta_keys( $meta ) {
-		return ! in_array( $meta->meta_key, $this->internal_meta_keys, true ) && 0 !== stripos( $meta->meta_key, 'wp_' );
-	}
-
-	/**
-	 * Gets a list of props and meta keys that need updated based on change state
-	 * or if they are present in the database or not.
-	 *
-	 * @param  GetPaid_Data $object         The GetPaid_Data object.
-	 * @param  array   $meta_key_to_props   A mapping of meta keys => prop names.
-	 * @param  string  $meta_type           The internal WP meta type (post, user, etc).
-	 * @return array                        A mapping of meta keys => prop names, filtered by ones that should be updated.
-	 */
-	protected function get_props_to_update( $object, $meta_key_to_props, $meta_type = 'post' ) {
-		$props_to_update = array();
-		$changed_props   = $object->get_changes();
-
-		// Props should be updated if they are a part of the $changed array or don't exist yet.
-		foreach ( $meta_key_to_props as $meta_key => $prop ) {
-			if ( array_key_exists( $prop, $changed_props ) || ! metadata_exists( $meta_type, $object->get_id(), $meta_key ) ) {
-				$props_to_update[ $meta_key ] = $prop;
-			}
-		}
-
-		return $props_to_update;
-	}
-
-	/**
-	 * Read object data.
-	 *
-	 * @param GetPaid_Data $object GetPaid_Data object.
-	 * @param WP_Post   $post_object Post object.
-	 * @since 1.0.19
-	 */
-	protected function read_object_data( &$object, $post_object ) {
-		$id    = $object->get_id();
-		$props = array();
-
-		foreach ( $this->meta_key_to_props as $meta_key => $prop ) {
-			$props[ $prop ] = get_post_meta( $id, $meta_key, true );
-		}
-
-		// Set object properties.
-		$object->set_props( $props );
-
-		// Gets extra data associated with the object if needed.
-		foreach ( $object->get_extra_data_keys() as $key ) {
-			$function = 'set_' . $key;
-			if ( is_callable( array( $object, $function ) ) ) {
-				$object->{$function}( get_post_meta( $object->get_id(), $key, true ) );
-			}
-		}
-	}
-
-	/**
-	 * Helper method that updates all the post meta for an object based on it's settings in the GetPaid_Data class.
-	 *
-	 * @param GetPaid_Data $object GetPaid_Data object.
-	 * @since 1.0.19
-	 */
-	protected function update_post_meta( &$object ) {
-
-		$updated_props   = array();
-		$props_to_update = $this->get_props_to_update( $object, $this->meta_key_to_props );
-		$object_type     = $object->get_object_type();
-
-		foreach ( $props_to_update as $meta_key => $prop ) {
-			$value = $object->{"get_$prop"}( 'edit' );
-			$value = is_string( $value ) ? wp_slash( $value ) : $value;
-
-			$updated = $this->update_or_delete_post_meta( $object, $meta_key, $value );
-
-			if ( $updated ) {
-				$updated_props[] = $prop;
-			}
-		}
-
-		do_action( "getpaid_{$object_type}_object_updated_props", $object, $updated_props );
-	}
-
-	/**
-	 * Update meta data in, or delete it from, the database.
-	 *
-	 * Avoids storing meta when it's either an empty string or empty array or null.
-	 * Other empty values such as numeric 0 should still be stored.
-	 * Data-stores can force meta to exist using `must_exist_meta_keys`.
-	 *
-	 * Note: WordPress `get_metadata` function returns an empty string when meta data does not exist.
-	 *
-	 * @param GetPaid_Data $object The GetPaid_Data object.
-	 * @param string  $meta_key Meta key to update.
-	 * @param mixed   $meta_value Value to save.
-	 *
-	 * @since 1.0.19 Added to prevent empty meta being stored unless required.
-	 *
-	 * @return bool True if updated/deleted.
-	 */
-	protected function update_or_delete_post_meta( $object, $meta_key, $meta_value ) {
-		if ( in_array( $meta_value, array( array(), '', null ), true ) && ! in_array( $meta_key, $this->must_exist_meta_keys, true ) ) {
-			$updated = delete_post_meta( $object->get_id(), $meta_key );
-		} else {
-			$updated = update_post_meta( $object->get_id(), $meta_key, $meta_value );
-		}
-
-		return (bool) $updated;
-	}
-
-	/**
-	 * Return list of internal meta keys.
-	 *
-	 * @since 1.0.19
-	 * @return array
-	 */
-	public function get_internal_meta_keys() {
-		return $this->internal_meta_keys;
-	}
-
-	/**
-	 * Clear any caches.
-	 *
-	 * @param GetPaid_Data $object GetPaid_Data object.
-	 * @since 1.0.19
-	 */
-	protected function clear_caches( &$object ) {
-		clean_post_cache( $object->get_id() );
-	}
-
-	/**
-	 * Method to delete a data object from the database.
-	 *
-	 * @param GetPaid_Data $object GetPaid_Data object.
-	 * @param array    $args Array of args to pass to the delete method.
-	 *
-	 * @return void
-	 */
-	public function delete( &$object, $args = array() ) {
-		$id          = $object->get_id();
-		$object_type = $object->get_object_type();
-		$args        = wp_parse_args(
-			$args,
-			array(
-				'force_delete' => false,
-			)
-		);
-
-		if ( ! $id ) {
-			return;
-		}
-
-		if ( $args['force_delete'] ) {
-			wp_delete_post( $id, true );
-			$object->set_id( 0 );
-			do_action( "getpaid_delete_$object_type", $id );
-		} else {
-			wp_trash_post( $id );
-			$object->set_status( 'trash' );
-			do_action( "getpaid_trash_$object_type", $id );
-		}
-	}
-
-	/**
-	 * Get the status to save to the post object.
-	 *
-	 *
-	 * @since 1.0.19
-	 * @param  GetPaid_Data $object GetPaid_Data object.
-	 * @return string
-	 */
-	protected function get_post_status( $object ) {
-		$object_status = $object->get_status( 'edit' );
-		$object_type   = $object->get_object_type();
-
-		if ( ! $object_status ) {
-			$object_status = apply_filters( "getpaid_default_{$object_type}_status", 'draft' );
-		}
-
-		return $object_status;
-	}
+                $object->get_id()
+            )
+        );
+
+        $this->internal_meta_keys = array_merge( array_map( array( $this, 'prefix_key' ), $object->get_data_keys() ), $this->internal_meta_keys );
+        $meta_data                = array_filter( $raw_meta_data, array( $this, 'exclude_internal_meta_keys' ) );
+        return apply_filters( "getpaid_data_store_wp_{$this->meta_type}_read_meta", $meta_data, $object, $this );
+    }
+
+    /**
+     * Deletes meta based on meta ID.
+     *
+     * @since  1.0.19
+     * @param  GetPaid_Data  $object GetPaid_Data object.
+     * @param  stdClass $meta (containing at least ->id).
+     */
+    public function delete_meta( &$object, $meta ) {
+        delete_metadata_by_mid( $this->meta_type, $meta->id );
+    }
+
+    /**
+     * Add new piece of meta.
+     *
+     * @since  1.0.19
+     * @param  GetPaid_Data  $object GetPaid_Data object.
+     * @param  stdClass $meta (containing ->key and ->value).
+     * @return int meta ID
+     */
+    public function add_meta( &$object, $meta ) {
+        return add_metadata( $this->meta_type, $object->get_id(), $meta->key, is_string( $meta->value ) ? wp_slash( $meta->value ) : $meta->value, false );
+    }
+
+    /**
+     * Update meta.
+     *
+     * @since  1.0.19
+     * @param  GetPaid_Data  $object GetPaid_Data object.
+     * @param  stdClass $meta (containing ->id, ->key and ->value).
+     */
+    public function update_meta( &$object, $meta ) {
+        update_metadata_by_mid( $this->meta_type, $meta->id, $meta->value, $meta->key );
+    }
+
+    /**
+     * Table structure is slightly different between meta types, this function will return what we need to know.
+     *
+     * @since  1.0.19
+     * @return array Array elements: table, object_id_field, meta_id_field
+     */
+    protected function get_db_info() {
+        global $wpdb;
+
+        $meta_id_field = 'meta_id'; // users table calls this umeta_id so we need to track this as well.
+        $table         = $wpdb->prefix;
+
+        // If we are dealing with a type of metadata that is not a core type, the table should be prefixed.
+        if ( ! in_array( $this->meta_type, array( 'post', 'user', 'comment', 'term' ), true ) ) {
+            $table .= 'getpaid_';
+        }
+
+        $table          .= $this->meta_type . 'meta';
+        $object_id_field = $this->meta_type . '_id';
+
+        // Figure out our field names.
+        if ( 'user' === $this->meta_type ) {
+            $meta_id_field = 'umeta_id';
+            $table         = $wpdb->usermeta;
+        }
+
+        if ( ! empty( $this->object_id_field_for_meta ) ) {
+            $object_id_field = $this->object_id_field_for_meta;
+        }
+
+        return array(
+            'table'           => $table,
+            'object_id_field' => $object_id_field,
+            'meta_id_field'   => $meta_id_field,
+        );
+    }
+
+    /**
+     * Internal meta keys we don't want exposed as part of meta_data. This is in
+     * addition to all data props with _ prefix.
+     *
+     * @since 1.0.19
+     *
+     * @param string $key Prefix to be added to meta keys.
+     * @return string
+     */
+    protected function prefix_key( $key ) {
+        return '_' === substr( $key, 0, 1 ) ? $key : '_' . $key;
+    }
+
+    /**
+     * Callback to remove unwanted meta data.
+     *
+     * @param object $meta Meta object to check if it should be excluded or not.
+     * @return bool
+     */
+    protected function exclude_internal_meta_keys( $meta ) {
+        return ! in_array( $meta->meta_key, $this->internal_meta_keys, true ) && 0 !== stripos( $meta->meta_key, 'wp_' );
+    }
+
+    /**
+     * Gets a list of props and meta keys that need updated based on change state
+     * or if they are present in the database or not.
+     *
+     * @param  GetPaid_Data $object         The GetPaid_Data object.
+     * @param  array   $meta_key_to_props   A mapping of meta keys => prop names.
+     * @param  string  $meta_type           The internal WP meta type (post, user, etc).
+     * @return array                        A mapping of meta keys => prop names, filtered by ones that should be updated.
+     */
+    protected function get_props_to_update( $object, $meta_key_to_props, $meta_type = 'post' ) {
+        $props_to_update = array();
+        $changed_props   = $object->get_changes();
+
+        // Props should be updated if they are a part of the $changed array or don't exist yet.
+        foreach ( $meta_key_to_props as $meta_key => $prop ) {
+            if ( array_key_exists( $prop, $changed_props ) || ! metadata_exists( $meta_type, $object->get_id(), $meta_key ) ) {
+                $props_to_update[ $meta_key ] = $prop;
+            }
+        }
+
+        return $props_to_update;
+    }
+
+    /**
+     * Read object data.
+     *
+     * @param GetPaid_Data $object GetPaid_Data object.
+     * @param WP_Post   $post_object Post object.
+     * @since 1.0.19
+     */
+    protected function read_object_data( &$object, $post_object ) {
+        $id    = $object->get_id();
+        $props = array();
+
+        foreach ( $this->meta_key_to_props as $meta_key => $prop ) {
+            $props[ $prop ] = get_post_meta( $id, $meta_key, true );
+        }
+
+        // Set object properties.
+        $object->set_props( $props );
+
+        // Gets extra data associated with the object if needed.
+        foreach ( $object->get_extra_data_keys() as $key ) {
+            $function = 'set_' . $key;
+            if ( is_callable( array( $object, $function ) ) ) {
+                $object->{$function}( get_post_meta( $object->get_id(), $key, true ) );
+            }
+        }
+    }
+
+    /**
+     * Helper method that updates all the post meta for an object based on it's settings in the GetPaid_Data class.
+     *
+     * @param GetPaid_Data $object GetPaid_Data object.
+     * @since 1.0.19
+     */
+    protected function update_post_meta( &$object ) {
+
+        $updated_props   = array();
+        $props_to_update = $this->get_props_to_update( $object, $this->meta_key_to_props );
+        $object_type     = $object->get_object_type();
+
+        foreach ( $props_to_update as $meta_key => $prop ) {
+            $value = $object->{"get_$prop"}( 'edit' );
+            $value = is_string( $value ) ? wp_slash( $value ) : $value;
+
+            $updated = $this->update_or_delete_post_meta( $object, $meta_key, $value );
+
+            if ( $updated ) {
+                $updated_props[] = $prop;
+            }
+        }
+
+        do_action( "getpaid_{$object_type}_object_updated_props", $object, $updated_props );
+    }
+
+    /**
+     * Update meta data in, or delete it from, the database.
+     *
+     * Avoids storing meta when it's either an empty string or empty array or null.
+     * Other empty values such as numeric 0 should still be stored.
+     * Data-stores can force meta to exist using `must_exist_meta_keys`.
+     *
+     * Note: WordPress `get_metadata` function returns an empty string when meta data does not exist.
+     *
+     * @param GetPaid_Data $object The GetPaid_Data object.
+     * @param string  $meta_key Meta key to update.
+     * @param mixed   $meta_value Value to save.
+     *
+     * @since 1.0.19 Added to prevent empty meta being stored unless required.
+     *
+     * @return bool True if updated/deleted.
+     */
+    protected function update_or_delete_post_meta( $object, $meta_key, $meta_value ) {
+        if ( in_array( $meta_value, array( array(), '', null ), true ) && ! in_array( $meta_key, $this->must_exist_meta_keys, true ) ) {
+            $updated = delete_post_meta( $object->get_id(), $meta_key );
+        } else {
+            $updated = update_post_meta( $object->get_id(), $meta_key, $meta_value );
+        }
+
+        return (bool) $updated;
+    }
+
+    /**
+     * Return list of internal meta keys.
+     *
+     * @since 1.0.19
+     * @return array
+     */
+    public function get_internal_meta_keys() {
+        return $this->internal_meta_keys;
+    }
+
+    /**
+     * Clear any caches.
+     *
+     * @param GetPaid_Data $object GetPaid_Data object.
+     * @since 1.0.19
+     */
+    protected function clear_caches( &$object ) {
+        clean_post_cache( $object->get_id() );
+    }
+
+    /**
+     * Method to delete a data object from the database.
+     *
+     * @param GetPaid_Data $object GetPaid_Data object.
+     * @param array    $args Array of args to pass to the delete method.
+     *
+     * @return void
+     */
+    public function delete( &$object, $args = array() ) {
+        $id          = $object->get_id();
+        $object_type = $object->get_object_type();
+        $args        = wp_parse_args(
+            $args,
+            array(
+                'force_delete' => false,
+            )
+        );
+
+        if ( ! $id ) {
+            return;
+        }
+
+        if ( $args['force_delete'] ) {
+            wp_delete_post( $id, true );
+            $object->set_id( 0 );
+            do_action( "getpaid_delete_$object_type", $id );
+        } else {
+            wp_trash_post( $id );
+            $object->set_status( 'trash' );
+            do_action( "getpaid_trash_$object_type", $id );
+        }
+    }
+
+    /**
+     * Get the status to save to the post object.
+     *
+     *
+     * @since 1.0.19
+     * @param  GetPaid_Data $object GetPaid_Data object.
+     * @return string
+     */
+    protected function get_post_status( $object ) {
+        $object_status = $object->get_status( 'edit' );
+        $object_type   = $object->get_object_type();
+
+        if ( ! $object_status ) {
+            $object_status = apply_filters( "getpaid_default_{$object_type}_status", 'draft' );
+        }
+
+        return $object_status;
+    }
 
 }

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

Indentation +178 added lines, -178 removed lines

@@ -11,183 +11,183 @@
  */
 class GetPaid_Data_Store {
 
-	/**
-	 * Contains an instance of the data store class that we are working with.
-	 *
-	 * @var GetPaid_Data_Store
-	 */
-	private $instance = null;
-
-	/**
-	 * Contains an array of default supported data stores.
-	 * Format of object name => class name.
-	 * Example: 'item' => 'GetPaid_Item_Data_Store'
-	 * You can also pass something like item-<type> for item stores and
-	 * that type will be used first when available, if a store is requested like
-	 * this and doesn't exist, then the store would fall back to 'item'.
-	 * Ran through `getpaid_data_stores`.
-	 *
-	 * @var array
-	 */
-	private $stores = array(
-		'item'         => 'GetPaid_Item_Data_Store',
-		'payment_form' => 'GetPaid_Payment_Form_Data_Store',
-	);
-
-	/**
-	 * Contains the name of the current data store's class name.
-	 *
-	 * @var string
-	 */
-	private $current_class_name = '';
-
-	/**
-	 * The object type this store works with.
-	 *
-	 * @var string
-	 */
-	private $object_type = '';
-
-	/**
-	 * Tells GetPaid_Data_Store which object
-	 * store we want to work with.
-	 *
-	 * @param string $object_type Name of object.
-	 */
-	public function __construct( $object_type ) {
-		$this->object_type = $object_type;
-		$this->stores      = apply_filters( 'getpaid_data_stores', $this->stores );
-
-		// If this object type can't be found, check to see if we can load one
-		// level up (so if item-type isn't found, we try item).
-		if ( ! array_key_exists( $object_type, $this->stores ) ) {
-			$pieces      = explode( '-', $object_type );
-			$object_type = $pieces[0];
-		}
-
-		if ( array_key_exists( $object_type, $this->stores ) ) {
-			$store = apply_filters( 'getpaid_' . $object_type . '_data_store', $this->stores[ $object_type ] );
-			if ( is_object( $store ) ) {
-				$this->current_class_name = get_class( $store );
-				$this->instance           = $store;
-			} else {
-				if ( ! class_exists( $store ) ) {
-					throw new Exception( __( 'Data store class does not exist.', 'invoicing' ) );
-				}
-				$this->current_class_name = $store;
-				$this->instance           = new $store();
-			}
-		} else {
-			throw new Exception( __( 'Invalid data store.', 'invoicing' ) );
-		}
-	}
-
-	/**
-	 * Only store the object type to avoid serializing the data store instance.
-	 *
-	 * @return array
-	 */
-	public function __sleep() {
-		return array( 'object_type' );
-	}
-
-	/**
-	 * Re-run the constructor with the object type.
-	 *
-	 * @throws Exception When validation fails.
-	 */
-	public function __wakeup() {
-		$this->__construct( $this->object_type );
-	}
-
-	/**
-	 * Loads a data store.
-	 *
-	 * @param string $object_type Name of object.
-	 *
-	 * @since 1.0.19
-	 * @throws Exception When validation fails.
-	 * @return GetPaid_Data_Store
-	 */
-	public static function load( $object_type ) {
-		return new GetPaid_Data_Store( $object_type );
-	}
-
-	/**
-	 * Returns the class name of the current data store.
-	 *
-	 * @since 1.0.19
-	 * @return string
-	 */
-	public function get_current_class_name() {
-		return $this->current_class_name;
-	}
-
-	/**
-	 * Returns the object type of the current data store.
-	 *
-	 * @since 1.0.19
-	 * @return string
-	 */
-	public function get_object_type() {
-		return $this->object_type;
-	}
-
-	/**
-	 * Reads an object from the data store.
-	 *
-	 * @since 1.0.19
-	 * @param GetPaid_Data $data GetPaid data instance.
-	 */
-	public function read( &$data ) {
-		$this->instance->read( $data );
-	}
-
-	/**
-	 * Create an object in the data store.
-	 *
-	 * @since 1.0.19
-	 * @param GetPaid_Data $data GetPaid data instance.
-	 */
-	public function create( &$data ) {
-		$this->instance->create( $data );
-	}
-
-	/**
-	 * Update an object in the data store.
-	 *
-	 * @since 1.0.19
-	 * @param GetPaid_Data $data GetPaid data instance.
-	 */
-	public function update( &$data ) {
-		$this->instance->update( $data );
-	}
-
-	/**
-	 * Delete an object from the data store.
-	 *
-	 * @since 1.0.19
-	 * @param GetPaid_Data $data GetPaid data instance.
-	 * @param array   $args Array of args to pass to the delete method.
-	 */
-	public function delete( &$data, $args = array() ) {
-		$this->instance->delete( $data, $args );
-	}
-
-	/**
-	 * Data stores can define additional function. This passes
-	 * through to the instance if that function exists.
-	 *
-	 * @since 1.0.19
-	 * @param string $method     Method.
-	 * @return mixed
-	 */
-	public function __call( $method, $parameters ) {
-		if ( is_callable( array( $this->instance, $method ) ) ) {
-			$object     = array_shift( $parameters );
-			$parameters = array_merge( array( &$object ), $parameters );
-			return call_user_func_array( array( $this->instance, $method ), $parameters );
-		}
-	}
+    /**
+     * Contains an instance of the data store class that we are working with.
+     *
+     * @var GetPaid_Data_Store
+     */
+    private $instance = null;
+
+    /**
+     * Contains an array of default supported data stores.
+     * Format of object name => class name.
+     * Example: 'item' => 'GetPaid_Item_Data_Store'
+     * You can also pass something like item-<type> for item stores and
+     * that type will be used first when available, if a store is requested like
+     * this and doesn't exist, then the store would fall back to 'item'.
+     * Ran through `getpaid_data_stores`.
+     *
+     * @var array
+     */
+    private $stores = array(
+        'item'         => 'GetPaid_Item_Data_Store',
+        'payment_form' => 'GetPaid_Payment_Form_Data_Store',
+    );
+
+    /**
+     * Contains the name of the current data store's class name.
+     *
+     * @var string
+     */
+    private $current_class_name = '';
+
+    /**
+     * The object type this store works with.
+     *
+     * @var string
+     */
+    private $object_type = '';
+
+    /**
+     * Tells GetPaid_Data_Store which object
+     * store we want to work with.
+     *
+     * @param string $object_type Name of object.
+     */
+    public function __construct( $object_type ) {
+        $this->object_type = $object_type;
+        $this->stores      = apply_filters( 'getpaid_data_stores', $this->stores );
+
+        // If this object type can't be found, check to see if we can load one
+        // level up (so if item-type isn't found, we try item).
+        if ( ! array_key_exists( $object_type, $this->stores ) ) {
+            $pieces      = explode( '-', $object_type );
+            $object_type = $pieces[0];
+        }
+
+        if ( array_key_exists( $object_type, $this->stores ) ) {
+            $store = apply_filters( 'getpaid_' . $object_type . '_data_store', $this->stores[ $object_type ] );
+            if ( is_object( $store ) ) {
+                $this->current_class_name = get_class( $store );
+                $this->instance           = $store;
+            } else {
+                if ( ! class_exists( $store ) ) {
+                    throw new Exception( __( 'Data store class does not exist.', 'invoicing' ) );
+                }
+                $this->current_class_name = $store;
+                $this->instance           = new $store();
+            }
+        } else {
+            throw new Exception( __( 'Invalid data store.', 'invoicing' ) );
+        }
+    }
+
+    /**
+     * Only store the object type to avoid serializing the data store instance.
+     *
+     * @return array
+     */
+    public function __sleep() {
+        return array( 'object_type' );
+    }
+
+    /**
+     * Re-run the constructor with the object type.
+     *
+     * @throws Exception When validation fails.
+     */
+    public function __wakeup() {
+        $this->__construct( $this->object_type );
+    }
+
+    /**
+     * Loads a data store.
+     *
+     * @param string $object_type Name of object.
+     *
+     * @since 1.0.19
+     * @throws Exception When validation fails.
+     * @return GetPaid_Data_Store
+     */
+    public static function load( $object_type ) {
+        return new GetPaid_Data_Store( $object_type );
+    }
+
+    /**
+     * Returns the class name of the current data store.
+     *
+     * @since 1.0.19
+     * @return string
+     */
+    public function get_current_class_name() {
+        return $this->current_class_name;
+    }
+
+    /**
+     * Returns the object type of the current data store.
+     *
+     * @since 1.0.19
+     * @return string
+     */
+    public function get_object_type() {
+        return $this->object_type;
+    }
+
+    /**
+     * Reads an object from the data store.
+     *
+     * @since 1.0.19
+     * @param GetPaid_Data $data GetPaid data instance.
+     */
+    public function read( &$data ) {
+        $this->instance->read( $data );
+    }
+
+    /**
+     * Create an object in the data store.
+     *
+     * @since 1.0.19
+     * @param GetPaid_Data $data GetPaid data instance.
+     */
+    public function create( &$data ) {
+        $this->instance->create( $data );
+    }
+
+    /**
+     * Update an object in the data store.
+     *
+     * @since 1.0.19
+     * @param GetPaid_Data $data GetPaid data instance.
+     */
+    public function update( &$data ) {
+        $this->instance->update( $data );
+    }
+
+    /**
+     * Delete an object from the data store.
+     *
+     * @since 1.0.19
+     * @param GetPaid_Data $data GetPaid data instance.
+     * @param array   $args Array of args to pass to the delete method.
+     */
+    public function delete( &$data, $args = array() ) {
+        $this->instance->delete( $data, $args );
+    }
+
+    /**
+     * Data stores can define additional function. This passes
+     * through to the instance if that function exists.
+     *
+     * @since 1.0.19
+     * @param string $method     Method.
+     * @return mixed
+     */
+    public function __call( $method, $parameters ) {
+        if ( is_callable( array( $this->instance, $method ) ) ) {
+            $object     = array_shift( $parameters );
+            $parameters = array_merge( array( &$object ), $parameters );
+            return call_user_func_array( array( $this->instance, $method ), $parameters );
+        }
+    }
 
 }

includes/class-wpinv.php

Indentation +56 added lines, -56 removed lines

@@ -161,10 +161,10 @@ 
         require_once( WPINV_PLUGIN_DIR . 'includes/wpinv-error-functions.php' );
 
         // Register autoloader.
-		try {
-			spl_autoload_register( array( $this, 'autoload' ), true );
-		} catch ( Exception $e ) {
-			wpinv_error_log( $e->getMessage(), '', __FILE__, 149, true );
+        try {
+            spl_autoload_register( array( $this, 'autoload' ), true );
+        } catch ( Exception $e ) {
+            wpinv_error_log( $e->getMessage(), '', __FILE__, 149, true );
         }
 
         require_once( WPINV_PLUGIN_DIR . 'includes/wpinv-post-types.php' );
@@ -188,11 +188,11 @@ 
         require_once( WPINV_PLUGIN_DIR . 'includes/class-wpinv-privacy.php' );
         require_once( WPINV_PLUGIN_DIR . 'includes/libraries/class-ayecode-addons.php' );
         require_once( WPINV_PLUGIN_DIR . 'includes/class-wpinv-addons.php' );
-	    require_once( WPINV_PLUGIN_DIR . 'widgets/checkout.php' );
-	    require_once( WPINV_PLUGIN_DIR . 'widgets/invoice-history.php' );
-	    require_once( WPINV_PLUGIN_DIR . 'widgets/invoice-receipt.php' );
-	    require_once( WPINV_PLUGIN_DIR . 'widgets/invoice-messages.php' );
-	    require_once( WPINV_PLUGIN_DIR . 'widgets/subscriptions.php' );
+        require_once( WPINV_PLUGIN_DIR . 'widgets/checkout.php' );
+        require_once( WPINV_PLUGIN_DIR . 'widgets/invoice-history.php' );
+        require_once( WPINV_PLUGIN_DIR . 'widgets/invoice-receipt.php' );
+        require_once( WPINV_PLUGIN_DIR . 'widgets/invoice-messages.php' );
+        require_once( WPINV_PLUGIN_DIR . 'widgets/subscriptions.php' );
         require_once( WPINV_PLUGIN_DIR . 'widgets/buy-item.php' );
         require_once( WPINV_PLUGIN_DIR . 'widgets/getpaid.php' );
         require_once( WPINV_PLUGIN_DIR . 'includes/class-wpinv-payment-form-elements.php' );
@@ -254,47 +254,47 @@ 
     }
 
     /**
-	 * Class autoloader
-	 *
-	 * @param       string $class_name The name of the class to load.
-	 * @access      public
-	 * @since       1.0.19
-	 * @return      void
-	 */
-	public function autoload( $class_name ) {
-
-		// Normalize the class name...
-		$class_name  = strtolower( $class_name );
-
-		// ... and make sure it is our class.
-		if ( false === strpos( $class_name, 'getpaid_' ) && false === strpos( $class_name, 'wpinv_' ) ) {
-			return;
-		}
-
-		// Next, prepare the file name from the class.
-		$file_name = 'class-' . str_replace( '_', '-', $class_name ) . '.php';
-
-		// And an array of possible locations in order of importance.
-		$locations = array(
-			'includes',
-			'includes/data-stores',
+     * Class autoloader
+     *
+     * @param       string $class_name The name of the class to load.
+     * @access      public
+     * @since       1.0.19
+     * @return      void
+     */
+    public function autoload( $class_name ) {
+
+        // Normalize the class name...
+        $class_name  = strtolower( $class_name );
+
+        // ... and make sure it is our class.
+        if ( false === strpos( $class_name, 'getpaid_' ) && false === strpos( $class_name, 'wpinv_' ) ) {
+            return;
+        }
+
+        // Next, prepare the file name from the class.
+        $file_name = 'class-' . str_replace( '_', '-', $class_name ) . '.php';
+
+        // And an array of possible locations in order of importance.
+        $locations = array(
+            'includes',
+            'includes/data-stores',
             'includes/admin',
             'includes/admin/meta-boxes'
-		);
+        );
 
-		// Base path of the classes.
-		$plugin_path = untrailingslashit( WPINV_PLUGIN_DIR );
+        // Base path of the classes.
+        $plugin_path = untrailingslashit( WPINV_PLUGIN_DIR );
 
-		foreach ( $locations as $location ) {
+        foreach ( $locations as $location ) {
 
-			if ( file_exists( "$plugin_path/$location/$file_name" ) ) {
-				include "$plugin_path/$location/$file_name";
-				break;
-			}
+            if ( file_exists( "$plugin_path/$location/$file_name" ) ) {
+                include "$plugin_path/$location/$file_name";
+                break;
+            }
 
-		}
+        }
 
-	}
+    }
 
     public function init() {
     }
@@ -384,7 +384,7 @@ 
             wp_register_style( 'jquery-ui-css', WPINV_PLUGIN_URL . 'assets/css/jquery-ui' . $suffix . '.css', array(), '1.8.16' );
             wp_enqueue_style( 'jquery-ui-css' );
             wp_deregister_style( 'yoast-seo-select2' );
-	        wp_deregister_style( 'yoast-seo-monorepo' );
+            wp_deregister_style( 'yoast-seo-monorepo' );
         }
 
         wp_register_style( 'wpinv_meta_box_style', WPINV_PLUGIN_URL . 'assets/css/meta-box.css', array(), WPINV_VERSION );
@@ -398,7 +398,7 @@ 
         if ( $page == 'wpinv-subscriptions' ) {
             wp_enqueue_script( 'jquery-ui-datepicker' );
             wp_deregister_style( 'yoast-seo-select2' );
-	        wp_deregister_style( 'yoast-seo-monorepo' );
+            wp_deregister_style( 'yoast-seo-monorepo' );
         }
         
         if ( $enqueue_datepicker = apply_filters( 'wpinv_admin_enqueue_jquery_ui_datepicker', $enqueue ) ) {
@@ -564,19 +564,19 @@ 
         require_once( WPINV_PLUGIN_DIR . 'includes/class-wpinv-bp-core.php' );
     }
 
-	/**
-	 * Register widgets
-	 *
-	 */
-	public function register_widgets() {
-		register_widget( "WPInv_Checkout_Widget" );
-		register_widget( "WPInv_History_Widget" );
-		register_widget( "WPInv_Receipt_Widget" );
-		register_widget( "WPInv_Subscriptions_Widget" );
-		register_widget( "WPInv_Buy_Item_Widget" );
+    /**
+     * Register widgets
+     *
+     */
+    public function register_widgets() {
+        register_widget( "WPInv_Checkout_Widget" );
+        register_widget( "WPInv_History_Widget" );
+        register_widget( "WPInv_Receipt_Widget" );
+        register_widget( "WPInv_Subscriptions_Widget" );
+        register_widget( "WPInv_Buy_Item_Widget" );
         register_widget( "WPInv_Messages_Widget" );
         register_widget( 'WPInv_GetPaid_Widget' );
-	}
+    }
     
     /**
      * Remove our pages from yoast sitemaps.

includes/admin/meta-boxes/class-getpaid-meta-box-payment-form-info.php

Indentation +5 added lines, -5 removed lines

@@ -8,7 +8,7 @@ 
  */
 
 if ( ! defined( 'ABSPATH' ) ) {
-	exit; // Exit if accessed directly
+    exit; // Exit if accessed directly
 }
 
 /**
@@ -17,10 +17,10 @@ 
 class GetPaid_Meta_Box_Payment_Form_Info {
 
     /**
-	 * Output the metabox.
-	 *
-	 * @param WP_Post $post
-	 */
+     * Output the metabox.
+     *
+     * @param WP_Post $post
+     */
     public static function output( $post ) {
 
         // Prepare the form.

includes/wpinv-template-functions.php

Indentation +168 added lines, -168 removed lines

@@ -103,29 +103,29 @@ 
 
 function wpinv_get_template( $template_name, $args = array(), $template_path = '', $default_path = '' ) {
     if ( ! empty( $args ) && is_array( $args ) ) {
-		extract( $args );
-	}
+        extract( $args );
+    }
 
-	$located = wpinv_locate_template( $template_name, $template_path, $default_path );
-	// Allow 3rd party plugin filter template file from their plugin.
-	$located = apply_filters( 'wpinv_get_template', $located, $template_name, $args, $template_path, $default_path );
+    $located = wpinv_locate_template( $template_name, $template_path, $default_path );
+    // Allow 3rd party plugin filter template file from their plugin.
+    $located = apply_filters( 'wpinv_get_template', $located, $template_name, $args, $template_path, $default_path );
 
-	if ( ! file_exists( $located ) ) {
+    if ( ! file_exists( $located ) ) {
         _doing_it_wrong( __FUNCTION__, sprintf( '<code>%s</code> does not exist.', $located ), '2.1' );
-		return;
-	}
+        return;
+    }
 
-	do_action( 'wpinv_before_template_part', $template_name, $template_path, $located, $args );
+    do_action( 'wpinv_before_template_part', $template_name, $template_path, $located, $args );
 
-	include( $located );
+    include( $located );
 
-	do_action( 'wpinv_after_template_part', $template_name, $template_path, $located, $args );
+    do_action( 'wpinv_after_template_part', $template_name, $template_path, $located, $args );
 }
 
 function wpinv_get_template_html( $template_name, $args = array(), $template_path = '', $default_path = '' ) {
-	ob_start();
-	wpinv_get_template( $template_name, $args, $template_path, $default_path );
-	return ob_get_clean();
+    ob_start();
+    wpinv_get_template( $template_name, $args, $template_path, $default_path );
+    return ob_get_clean();
 }
 
 function wpinv_locate_template( $template_name, $template_path = '', $default_path = '' ) {
@@ -155,126 +155,126 @@ 
 }
 
 function wpinv_get_template_part( $slug, $name = null, $load = true ) {
-	do_action( 'get_template_part_' . $slug, $slug, $name );
+    do_action( 'get_template_part_' . $slug, $slug, $name );
 
-	// Setup possible parts
-	$templates = array();
-	if ( isset( $name ) )
-		$templates[] = $slug . '-' . $name . '.php';
-	$templates[] = $slug . '.php';
+    // Setup possible parts
+    $templates = array();
+    if ( isset( $name ) )
+        $templates[] = $slug . '-' . $name . '.php';
+    $templates[] = $slug . '.php';
 
-	// Allow template parts to be filtered
-	$templates = apply_filters( 'wpinv_get_template_part', $templates, $slug, $name );
+    // Allow template parts to be filtered
+    $templates = apply_filters( 'wpinv_get_template_part', $templates, $slug, $name );
 
-	// Return the part that is found
-	return wpinv_locate_tmpl( $templates, $load, false );
+    // Return the part that is found
+    return wpinv_locate_tmpl( $templates, $load, false );
 }
 
 function wpinv_locate_tmpl( $template_names, $load = false, $require_once = true ) {
-	// No file found yet
-	$located = false;
+    // No file found yet
+    $located = false;
 
-	// Try to find a template file
-	foreach ( (array)$template_names as $template_name ) {
+    // Try to find a template file
+    foreach ( (array)$template_names as $template_name ) {
 
-		// Continue if template is empty
-		if ( empty( $template_name ) )
-			continue;
+        // Continue if template is empty
+        if ( empty( $template_name ) )
+            continue;
 
-		// Trim off any slashes from the template name
-		$template_name = ltrim( $template_name, '/' );
+        // Trim off any slashes from the template name
+        $template_name = ltrim( $template_name, '/' );
 
-		// try locating this template file by looping through the template paths
-		foreach( wpinv_get_theme_template_paths() as $template_path ) {
+        // try locating this template file by looping through the template paths
+        foreach( wpinv_get_theme_template_paths() as $template_path ) {
 
-			if( file_exists( $template_path . $template_name ) ) {
-				$located = $template_path . $template_name;
-				break;
-			}
-		}
+            if( file_exists( $template_path . $template_name ) ) {
+                $located = $template_path . $template_name;
+                break;
+            }
+        }
 
-		if( !empty( $located ) ) {
-			break;
-		}
-	}
+        if( !empty( $located ) ) {
+            break;
+        }
+    }
 
-	if ( ( true == $load ) && ! empty( $located ) )
-		load_template( $located, $require_once );
+    if ( ( true == $load ) && ! empty( $located ) )
+        load_template( $located, $require_once );
 
-	return $located;
+    return $located;
 }
 
 function wpinv_get_theme_template_paths() {
-	$template_dir = wpinv_get_theme_template_dir_name();
+    $template_dir = wpinv_get_theme_template_dir_name();
 
-	$file_paths = array(
-		1 => trailingslashit( get_stylesheet_directory() ) . $template_dir,
-		10 => trailingslashit( get_template_directory() ) . $template_dir,
-		100 => wpinv_get_templates_dir()
-	);
+    $file_paths = array(
+        1 => trailingslashit( get_stylesheet_directory() ) . $template_dir,
+        10 => trailingslashit( get_template_directory() ) . $template_dir,
+        100 => wpinv_get_templates_dir()
+    );
 
-	$file_paths = apply_filters( 'wpinv_template_paths', $file_paths );
+    $file_paths = apply_filters( 'wpinv_template_paths', $file_paths );
 
-	// sort the file paths based on priority
-	ksort( $file_paths, SORT_NUMERIC );
+    // sort the file paths based on priority
+    ksort( $file_paths, SORT_NUMERIC );
 
-	return array_map( 'trailingslashit', $file_paths );
+    return array_map( 'trailingslashit', $file_paths );
 }
 
 function wpinv_get_theme_template_dir_name() {
-	return trailingslashit( apply_filters( 'wpinv_templates_dir', 'invoicing' ) );
+    return trailingslashit( apply_filters( 'wpinv_templates_dir', 'invoicing' ) );
 }
 
 function wpinv_checkout_meta_tags() {
 
-	$pages   = array();
-	$pages[] = wpinv_get_option( 'success_page' );
-	$pages[] = wpinv_get_option( 'failure_page' );
-	$pages[] = wpinv_get_option( 'invoice_history_page' );
-	$pages[] = wpinv_get_option( 'invoice_subscription_page' );
+    $pages   = array();
+    $pages[] = wpinv_get_option( 'success_page' );
+    $pages[] = wpinv_get_option( 'failure_page' );
+    $pages[] = wpinv_get_option( 'invoice_history_page' );
+    $pages[] = wpinv_get_option( 'invoice_subscription_page' );
 
-	if( !wpinv_is_checkout() && !is_page( $pages ) ) {
-		return;
-	}
+    if( !wpinv_is_checkout() && !is_page( $pages ) ) {
+        return;
+    }
 
-	echo '<meta name="robots" content="noindex,nofollow" />' . "\n";
+    echo '<meta name="robots" content="noindex,nofollow" />' . "\n";
 }
 add_action( 'wp_head', 'wpinv_checkout_meta_tags' );
 
 function wpinv_add_body_classes( $class ) {
-	$classes = (array)$class;
+    $classes = (array)$class;
 
-	if( wpinv_is_checkout() ) {
-		$classes[] = 'wpinv-checkout';
-		$classes[] = 'wpinv-page';
-	}
+    if( wpinv_is_checkout() ) {
+        $classes[] = 'wpinv-checkout';
+        $classes[] = 'wpinv-page';
+    }
 
-	if( wpinv_is_success_page() ) {
-		$classes[] = 'wpinv-success';
-		$classes[] = 'wpinv-page';
-	}
+    if( wpinv_is_success_page() ) {
+        $classes[] = 'wpinv-success';
+        $classes[] = 'wpinv-page';
+    }
 
-	if( wpinv_is_failed_transaction_page() ) {
-		$classes[] = 'wpinv-failed-transaction';
-		$classes[] = 'wpinv-page';
-	}
+    if( wpinv_is_failed_transaction_page() ) {
+        $classes[] = 'wpinv-failed-transaction';
+        $classes[] = 'wpinv-page';
+    }
 
-	if( wpinv_is_invoice_history_page() ) {
-		$classes[] = 'wpinv-history';
-		$classes[] = 'wpinv-page';
-	}
+    if( wpinv_is_invoice_history_page() ) {
+        $classes[] = 'wpinv-history';
+        $classes[] = 'wpinv-page';
+    }
 
-	if( wpinv_is_subscriptions_history_page() ) {
-		$classes[] = 'wpinv-subscription';
-		$classes[] = 'wpinv-page';
-	}
+    if( wpinv_is_subscriptions_history_page() ) {
+        $classes[] = 'wpinv-subscription';
+        $classes[] = 'wpinv-page';
+    }
 
-	if( wpinv_is_test_mode() ) {
-		$classes[] = 'wpinv-test-mode';
-		$classes[] = 'wpinv-page';
-	}
+    if( wpinv_is_test_mode() ) {
+        $classes[] = 'wpinv-test-mode';
+        $classes[] = 'wpinv-page';
+    }
 
-	return array_unique( $classes );
+    return array_unique( $classes );
 }
 add_filter( 'body_class', 'wpinv_add_body_classes' );
 
@@ -958,21 +958,21 @@ 
 
     $formatted_address = str_ireplace( array_keys( $replacements ), $replacements, $format );
     
-	// Remove unavailable tags.
+    // Remove unavailable tags.
     $formatted_address = preg_replace( "/\{\{\w+\}\}/", '', $formatted_address );
 
     // Clean up white space.
-	$formatted_address = preg_replace( '/  +/', ' ', trim( $formatted_address ) );
+    $formatted_address = preg_replace( '/  +/', ' ', trim( $formatted_address ) );
     $formatted_address = preg_replace( '/\n\n+/', "\n", $formatted_address );
     
     // Break newlines apart and remove empty lines/trim commas and white space.
-	$formatted_address = array_filter( array_map( 'wpinv_trim_formatted_address_line', explode( "\n", $formatted_address ) ) );
+    $formatted_address = array_filter( array_map( 'wpinv_trim_formatted_address_line', explode( "\n", $formatted_address ) ) );
 
     // Add html breaks.
-	$formatted_address = implode( $separator, $formatted_address );
+    $formatted_address = implode( $separator, $formatted_address );
 
-	// We're done!
-	return $formatted_address;
+    // We're done!
+    return $formatted_address;
     
 }
 
@@ -1059,7 +1059,7 @@ 
 
                     $item       = $item_id ? new WPInv_Item( $item_id ) : NULL;
                     $summary    = '';
-	                $item_name    = '';
+                    $item_name    = '';
                     $cols       = 3;
                     if ( !empty($item) ) {
                         $item_name  = $item->get_name();
@@ -1416,13 +1416,13 @@ 
     $payment_form    = wpinv_get_default_payment_form();
 
     ob_start();
-	    do_action( 'wpinv_checkout_content_before' );
+        do_action( 'wpinv_checkout_content_before' );
 
         if ( wpinv_get_cart_contents() ) {
 
             // Get the form elements and items.
-	        $elements = $invoicing->form_elements->get_form_elements( $payment_form );
-	        $items    = $invoicing->form_elements->convert_checkout_items( wpinv_get_cart_contents(), wpinv_get_invoice_cart() );
+            $elements = $invoicing->form_elements->get_form_elements( $payment_form );
+            $items    = $invoicing->form_elements->convert_checkout_items( wpinv_get_cart_contents(), wpinv_get_invoice_cart() );
             ?>
             <form class="wpinv_payment_form" action="<?php echo $form_action; ?>" method="POST">
                 <?php do_action( 'wpinv_main_checkout_form_top' ); ?>
@@ -1446,10 +1446,10 @@ 
             do_action( 'wpinv_cart_empty' );
         }
         echo '</div><!--end #wpinv_checkout_wrap-->';
-	    do_action( 'wpinv_checkout_content_after' );
+        do_action( 'wpinv_checkout_content_after' );
         $content = ob_get_clean();
 
-		return str_replace( 'sr-only', '', $content );
+        return str_replace( 'sr-only', '', $content );
 }
 
 function wpinv_checkout_cart( $cart_details = array(), $echo = true ) {
@@ -1475,7 +1475,7 @@ 
 add_action( 'wpinv_checkout_cart', 'wpinv_checkout_cart', 10 );
 
 function wpinv_empty_cart_message() {
-	return apply_filters( 'wpinv_empty_cart_message', '<span class="wpinv_empty_cart">' . __( 'Your cart is empty.', 'invoicing' ) . '</span>' );
+    return apply_filters( 'wpinv_empty_cart_message', '<span class="wpinv_empty_cart">' . __( 'Your cart is empty.', 'invoicing' ) . '</span>' );
 }
 
 /**
@@ -2295,14 +2295,14 @@ 
     global $invoicing;
 
     // Ensure that it is published.
-	if ( 'publish' != get_post_status( $form ) ) {
-		return aui()->alert(
-			array(
-				'type'    => 'warning',
-				'content' => __( 'This payment form is no longer active', 'invoicing' ),
-			)
-		);
-	}
+    if ( 'publish' != get_post_status( $form ) ) {
+        return aui()->alert(
+            array(
+                'type'    => 'warning',
+                'content' => __( 'This payment form is no longer active', 'invoicing' ),
+            )
+        );
+    }
 
     // Get the form.
     $form = new GetPaid_Payment_Form( $form );
@@ -2318,46 +2318,46 @@ 
     global $invoicing;
 
     foreach ( array_keys( $items ) as $id ) {
-	    if ( 'publish' != get_post_status( $id ) ) {
-		    unset( $items[ $id ] );
-	    }
+        if ( 'publish' != get_post_status( $id ) ) {
+            unset( $items[ $id ] );
+        }
     }
 
     if ( empty( $items ) ) {
-		return aui()->alert(
-			array(
-				'type'    => 'warning',
-				'content' => __( 'No published items found', 'invoicing' ),
-			)
-		);
+        return aui()->alert(
+            array(
+                'type'    => 'warning',
+                'content' => __( 'No published items found', 'invoicing' ),
+            )
+        );
     }
 
     $item_key = getpaid_convert_items_to_string( $items );
 
     // Get the form elements and items.
     $form     = wpinv_get_default_payment_form();
-	$elements = $invoicing->form_elements->get_form_elements( $form );
-	$items    = $invoicing->form_elements->convert_normal_items( $items );
+    $elements = $invoicing->form_elements->get_form_elements( $form );
+    $items    = $invoicing->form_elements->convert_normal_items( $items );
 
-	ob_start();
-	echo "<form class='wpinv_payment_form'>";
-	do_action( 'wpinv_payment_form_top' );
+    ob_start();
+    echo "<form class='wpinv_payment_form'>";
+    do_action( 'wpinv_payment_form_top' );
     echo "<input type='hidden' name='form_id' value='$form'/>";
     echo "<input type='hidden' name='form_items' value='$item_key'/>";
-	wp_nonce_field( 'wpinv_payment_form', 'wpinv_payment_form' );
-	wp_nonce_field( 'vat_validation', '_wpi_nonce' );
+    wp_nonce_field( 'wpinv_payment_form', 'wpinv_payment_form' );
+    wp_nonce_field( 'vat_validation', '_wpi_nonce' );
 
-	foreach ( $elements as $element ) {
-		do_action( 'wpinv_frontend_render_payment_form_element', $element, $items, $form );
-		do_action( "wpinv_frontend_render_payment_form_{$element['type']}", $element, $items, $form );
-	}
+    foreach ( $elements as $element ) {
+        do_action( 'wpinv_frontend_render_payment_form_element', $element, $items, $form );
+        do_action( "wpinv_frontend_render_payment_form_{$element['type']}", $element, $items, $form );
+    }
 
-	echo "<div class='wpinv_payment_form_errors alert alert-danger d-none'></div>";
-	do_action( 'wpinv_payment_form_bottom' );
-	echo '</form>';
+    echo "<div class='wpinv_payment_form_errors alert alert-danger d-none'></div>";
+    do_action( 'wpinv_payment_form_bottom' );
+    echo '</form>';
 
-	$content = ob_get_clean();
-	return str_replace( 'sr-only', '', $content );
+    $content = ob_get_clean();
+    return str_replace( 'sr-only', '', $content );
 }
 
 /**
@@ -2369,47 +2369,47 @@ 
     $invoice = wpinv_get_invoice( $invoice_id );
 
     if ( empty( $invoice ) ) {
-		return aui()->alert(
-			array(
-				'type'    => 'warning',
-				'content' => __( 'Invoice not found', 'invoicing' ),
-			)
-		);
+        return aui()->alert(
+            array(
+                'type'    => 'warning',
+                'content' => __( 'Invoice not found', 'invoicing' ),
+            )
+        );
     }
 
     if ( $invoice->is_paid() ) {
-		return aui()->alert(
-			array(
-				'type'    => 'warning',
-				'content' => __( 'Invoice has already been paid', 'invoicing' ),
-			)
-		);
+        return aui()->alert(
+            array(
+                'type'    => 'warning',
+                'content' => __( 'Invoice has already been paid', 'invoicing' ),
+            )
+        );
     }
 
     // Get the form elements and items.
     $form     = wpinv_get_default_payment_form();
-	$elements = $invoicing->form_elements->get_form_elements( $form );
-	$items    = $invoicing->form_elements->convert_checkout_items( $invoice->cart_details, $invoice );
+    $elements = $invoicing->form_elements->get_form_elements( $form );
+    $items    = $invoicing->form_elements->convert_checkout_items( $invoice->cart_details, $invoice );
 
-	ob_start();
-	echo "<form class='wpinv_payment_form'>";
-	do_action( 'wpinv_payment_form_top' );
+    ob_start();
+    echo "<form class='wpinv_payment_form'>";
+    do_action( 'wpinv_payment_form_top' );
     echo "<input type='hidden' name='form_id' value='$form'/>";
     echo "<input type='hidden' name='invoice_id' value='$invoice_id'/>";
-	wp_nonce_field( 'wpinv_payment_form', 'wpinv_payment_form' );
-	wp_nonce_field( 'vat_validation', '_wpi_nonce' );
+    wp_nonce_field( 'wpinv_payment_form', 'wpinv_payment_form' );
+    wp_nonce_field( 'vat_validation', '_wpi_nonce' );
 
-	foreach ( $elements as $element ) {
-		do_action( 'wpinv_frontend_render_payment_form_element', $element, $items, $form );
-		do_action( "wpinv_frontend_render_payment_form_{$element['type']}", $element, $items, $form );
-	}
+    foreach ( $elements as $element ) {
+        do_action( 'wpinv_frontend_render_payment_form_element', $element, $items, $form );
+        do_action( "wpinv_frontend_render_payment_form_{$element['type']}", $element, $items, $form );
+    }
 
-	echo "<div class='wpinv_payment_form_errors alert alert-danger d-none'></div>";
-	do_action( 'wpinv_payment_form_bottom' );
-	echo '</form>';
+    echo "<div class='wpinv_payment_form_errors alert alert-danger d-none'></div>";
+    do_action( 'wpinv_payment_form_bottom' );
+    echo '</form>';
 
-	$content = ob_get_clean();
-	return str_replace( 'sr-only', '', $content );
+    $content = ob_get_clean();
+    return str_replace( 'sr-only', '', $content );
 }
 
 /**
@@ -2464,7 +2464,7 @@ 
         return "<button class='btn btn-primary getpaid-payment-button' type='button' data-nonce='$nonce' data-form='$form'>$label</button>"; 
     }
 	
-	if ( ! empty( $items ) ) {
+    if ( ! empty( $items ) ) {
         $items  = esc_attr( $items );
         return "<button class='btn btn-primary getpaid-payment-button' type='button' data-nonce='$nonce' data-item='$items'>$label</button>"; 
     }