AyeCode / invoicing

includes/class-getpaid-template.php

Indentation +152 added lines, -152 removed lines

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

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

Indentation +363 added lines, -363 removed lines

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

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

Indentation +862 added lines, -862 removed lines

@@ -9,7 +9,7 @@ 
  */
 
 if ( ! defined( 'ABSPATH' ) ) {
-	exit;
+    exit;
 }
 
 /**
@@ -21,356 +21,356 @@ 
  */
 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|string $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() {
-		$this->__construct( absint( $this->id ) );
-
-		if ( ! empty( $this->last_error ) ) {
-			$this->set_id( 0 );
-		}
-
-	}
-
-	/**
-	 * 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->exists() ) {
-			$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.', 'invoicing' ), $key ), '1.0.19' );
-
-		return true;
-	}
-
-	/**
-	 * Magic method for setting data fields.
-	 *
-	 * This method does not update custom fields in the database.
-	 *
-	 * @since 1.0.19
-	 * @access public
-	 *
-	 */
-	public function __set( $key, $value ) {
-
-		if ( 'id' == strtolower( $key ) ) {
-			return $this->set_id( $value );
-		}
-
-		if ( method_exists( $this, "set_$key") ) {
-
-			/* translators: %s: $key Key to set */
-			getpaid_doing_it_wrong( __FUNCTION__, sprintf( __( 'Object data such as "%s" should not be accessed directly. Use getters and setters.', 'invoicing' ), $key ), '1.0.19' );
-
-			call_user_func( array( $this, "set_$key" ), $value );
-		} else {
-			$this->set_prop( $key, $value );
-		}
-
-	}
-
-	/**
+    /**
+     * 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|string $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() {
+        $this->__construct( absint( $this->id ) );
+
+        if ( ! empty( $this->last_error ) ) {
+            $this->set_id( 0 );
+        }
+
+    }
+
+    /**
+     * 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->exists() ) {
+            $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.', 'invoicing' ), $key ), '1.0.19' );
+
+        return true;
+    }
+
+    /**
+     * Magic method for setting data fields.
+     *
+     * This method does not update custom fields in the database.
+     *
+     * @since 1.0.19
+     * @access public
+     *
+     */
+    public function __set( $key, $value ) {
+
+        if ( 'id' == strtolower( $key ) ) {
+            return $this->set_id( $value );
+        }
+
+        if ( method_exists( $this, "set_$key") ) {
+
+            /* translators: %s: $key Key to set */
+            getpaid_doing_it_wrong( __FUNCTION__, sprintf( __( 'Object data such as "%s" should not be accessed directly. Use getters and setters.', 'invoicing' ), $key ), '1.0.19' );
+
+            call_user_func( array( $this, "set_$key" ), $value );
+        } else {
+            $this->set_prop( $key, $value );
+        }
+
+    }
+
+    /**
      * Margic method for retrieving a property.
      */
     public function __get( $key ) {
@@ -378,10 +378,10 @@ 
         // Check if we have a helper method for that.
         if ( method_exists( $this, 'get_' . $key ) ) {
 
-			if ( 'post_type' != $key ) {
-				/* translators: %s: $key Key to set */
-				getpaid_doing_it_wrong( __FUNCTION__, sprintf( __( 'Object data such as "%s" should not be accessed directly. Use getters and setters.', 'invoicing' ), $key ), '1.0.19' );
-			}
+            if ( 'post_type' != $key ) {
+                /* translators: %s: $key Key to set */
+                getpaid_doing_it_wrong( __FUNCTION__, sprintf( __( 'Object data such as "%s" should not be accessed directly. Use getters and setters.', 'invoicing' ), $key ), '1.0.19' );
+            }
 
             return call_user_func( array( $this, 'get_' . $key ) );
         }
@@ -391,514 +391,514 @@ 
             return $this->post->$key;
         }
 
-		return $this->get_prop( $key );
-
-    }
-
-	/**
-	 * 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.
-		$_key = str_replace( '_wpinv', '', $key );
-		$_key = str_replace( 'wpinv', '', $_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,
-			)
-		);
-
-		$this->save();
-	}
-
-	/**
-	 * 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 ) {
-
-		// Reset meta data.
-		$this->meta_data = array();
-
-		// Maybe abort early.
-		if ( ! $this->get_id() || ! $this->data_store ) {
-			return;
-		}
-
-		// Only read from cache if the cache key is set.
-		$cache_key = null;
-		if ( ! $force_read && ! 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();
-			$raw_meta_data = wp_cache_get( $cache_key, $this->cache_group );
-		}
-
-		// Should we force read?
-		if ( empty( $raw_meta_data ) ) {
-			$raw_meta_data = $this->data_store->read_meta( $this );
-
-			if ( ! empty( $cache_key ) ) {
-				wp_cache_set( $cache_key, $raw_meta_data, $this->cache_group );
-			}
-
-		}
-
-		// Set meta data.
-		if ( is_array( $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 ),
-					)
-				);
-			}
-
-		}
-
-	}
-
-	/**
-	 * 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 ) {
+        return $this->get_prop( $key );
+
+    }
+
+    /**
+     * 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.
+        $_key = str_replace( '_wpinv', '', $key );
+        $_key = str_replace( 'wpinv', '', $_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,
+            )
+        );
+
+        $this->save();
+    }
+
+    /**
+     * 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 ) {
+
+        // Reset meta data.
+        $this->meta_data = array();
+
+        // Maybe abort early.
+        if ( ! $this->get_id() || ! $this->data_store ) {
+            return;
+        }
+
+        // Only read from cache if the cache key is set.
+        $cache_key = null;
+        if ( ! $force_read && ! 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();
+            $raw_meta_data = wp_cache_get( $cache_key, $this->cache_group );
+        }
+
+        // Should we force read?
+        if ( empty( $raw_meta_data ) ) {
+            $raw_meta_data = $this->data_store->read_meta( $this );
+
+            if ( ! empty( $cache_key ) ) {
+                wp_cache_set( $cache_key, $raw_meta_data, $this->cache_group );
+            }
+
+        }
+
+        // Set meta data.
+        if ( is_array( $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 ),
+                    )
+                );
+            }
+
+        }
+
+    }
+
+    /**
+     * 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( $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.
-	 *
-	 * @since 1.0.19
-	 * @param string $code             Error code.
-	 * @param string $message          Error message.
-	 */
-	protected function error( $code, $message ) {
-		$this->last_error = $message;
-	}
-
-	/**
-	 * Checks if the object is saved in the database
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
-	public function exists() {
-		$id = $this->get_id();
-		return ! empty( $id );
-	}
+        $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( $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.
+     *
+     * @since 1.0.19
+     * @param string $code             Error code.
+     * @param string $message          Error message.
+     */
+    protected function error( $code, $message ) {
+        $this->last_error = $message;
+    }
+
+    /**
+     * Checks if the object is saved in the database
+     *
+     * @since 1.0.19
+     * @return bool
+     */
+    public function exists() {
+        $id = $this->get_id();
+        return ! empty( $id );
+    }
 
 }

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

Indentation +245 added lines, -245 removed lines

@@ -13,288 +13,288 @@
 class GetPaid_Subscription_Notification_Emails {
 
     /**
-	 * The array of subscription email actions.
-	 *
-	 * @param array
-	 */
-	public $subscription_actions;
+     * The array of subscription email actions.
+     *
+     * @param array
+     */
+    public $subscription_actions;
 
     /**
-	 * Class constructor
+     * Class constructor
      *
-	 */
-	public function __construct() {
-
-		$this->subscription_actions = apply_filters(
-			'getpaid_notification_email_subscription_triggers',
-			array(
-				'getpaid_subscription_trialling' => 'subscription_trial',
-				'getpaid_subscription_cancelled' => 'subscription_cancelled',
-				'getpaid_subscription_expired'   => 'subscription_expired',
-				'getpaid_subscription_completed' => 'subscription_complete',
-				'getpaid_daily_maintenance'      => 'renewal_reminder',
-			)
-		);
-
-		$this->init_hooks();
+     */
+    public function __construct() {
+
+        $this->subscription_actions = apply_filters(
+            'getpaid_notification_email_subscription_triggers',
+            array(
+                'getpaid_subscription_trialling' => 'subscription_trial',
+                'getpaid_subscription_cancelled' => 'subscription_cancelled',
+                'getpaid_subscription_expired'   => 'subscription_expired',
+                'getpaid_subscription_completed' => 'subscription_complete',
+                'getpaid_daily_maintenance'      => 'renewal_reminder',
+            )
+        );
+
+        $this->init_hooks();
 
     }
 
     /**
-	 * Registers email hooks.
-	 */
-	public function init_hooks() {
-
-		add_filter( 'getpaid_get_email_merge_tags', array( $this, 'subscription_merge_tags' ), 10, 2 );
-		foreach ( $this->subscription_actions as $hook => $email_type ) {
-
-			$email = new GetPaid_Notification_Email( $email_type );
-
-			if ( ! $email->is_active() ) {
-				continue;
-			}
-
-			if ( method_exists( $this, $email_type ) ) {
-				add_action( $hook, array( $this, $email_type ), 100, 2 );
-				continue;
-			}
-
-			do_action( 'getpaid_subscription_notification_email_register_hook', $email_type, $hook );
-
-		}
-
-	}
-
-	/**
-	 * Filters subscription merge tags.
-	 *
-	 * @param array $merge_tags
-	 * @param mixed|WPInv_Invoice|WPInv_Subscription $object
-	 */
-	public function subscription_merge_tags( $merge_tags, $object ) {
-
-		if ( is_a( $object, 'WPInv_Subscription' ) ) {
-			$merge_tags = array_merge(
-				$merge_tags,
-				$this->get_subscription_merge_tags( $object )
-			);
-		}
-
-		return $merge_tags;
-
-	}
-
-	/**
-	 * Generates subscription merge tags.
-	 *
-	 * @param WPInv_Subscription $subscription
-	 * @return array
-	 */
-	public function get_subscription_merge_tags( $subscription ) {
-
-		// Abort if it does not exist.
-		if ( ! $subscription->get_id() ) {
-			return array();
-		}
-
-		$invoice    = $subscription->get_parent_invoice();
-		return array(
-			'{subscription_renewal_date}'     => getpaid_format_date_value( $subscription->get_next_renewal_date(), __( 'Never', 'invoicing' ) ),
-			'{subscription_created}'          => getpaid_format_date_value( $subscription->get_date_created() ),
-			'{subscription_status}'           => sanitize_text_field( $subscription->get_status_label() ),
-			'{subscription_profile_id}'       => sanitize_text_field( $subscription->get_profile_id() ),
-			'{subscription_id}'               => absint( $subscription->get_id() ),
-			'{subscription_recurring_amount}' => sanitize_text_field( wpinv_price( $subscription->get_recurring_amount(), $invoice->get_currency() ) ),
-			'{subscription_initial_amount}'   => sanitize_text_field( wpinv_price( $subscription->get_initial_amount(), $invoice->get_currency() ) ),
-			'{subscription_recurring_period}' => getpaid_get_subscription_period_label( $subscription->get_period(), $subscription->get_frequency(), '' ),
-			'{subscription_bill_times}'       => $subscription->get_bill_times(),
-			'{subscription_url}'              => esc_url( $subscription->get_view_url() ),
-		);
-
-	}
-
-	/**
-	 * Checks if we should send a notification for a subscription.
-	 *
-	 * @param WPInv_Invoice $invoice
-	 * @return bool
-	 */
-	public function should_send_notification( $invoice ) {
-		return 0 != $invoice->get_id();
-	}
-
-	/**
-	 * Returns notification recipients.
-	 *
-	 * @param WPInv_Invoice $invoice
-	 * @return array
-	 */
-	public function get_recipients( $invoice ) {
-		$recipients = array( $invoice->get_email() );
-
-		$cc = $invoice->get_email_cc();
-
-		if ( ! empty( $cc ) ) {
-			$cc = array_map( 'sanitize_email', wpinv_parse_list( $cc ) );
-			$recipients = array_filter( array_unique( array_merge( $recipients, $cc ) ) );
-		}
-
-		return $recipients;
-	}
-
-	/**
-	 * Helper function to send an email.
-	 *
-	 * @param WPInv_Subscription $subscription
-	 * @param GetPaid_Notification_Email $email
-	 * @param string $type
-	 * @param array $extra_args Extra template args.
-	 */
-	public function send_email( $subscription, $email, $type, $extra_args = array() ) {
-
-		// Abort in case the parent invoice does not exist.
-		$invoice = $subscription->get_parent_invoice();
-		if ( ! $this->should_send_notification( $invoice ) ) {
-			return;
-		}
-
-		if ( apply_filters( 'getpaid_skip_subscription_email', false, $type, $subscription ) ) {
-			return;
-		}
-
-		do_action( 'getpaid_before_send_subscription_notification', $type, $subscription, $email );
-
-		$recipients  = $this->get_recipients( $invoice );
-		$mailer      = new GetPaid_Notification_Email_Sender();
-		$merge_tags  = $email->get_merge_tags();
-		$content     = $email->get_content( $merge_tags, $extra_args );
-		$subject     = $email->add_merge_tags( $email->get_subject(), $merge_tags );
-		$attachments = $email->get_attachments();
-
-		$result = $mailer->send(
-			apply_filters( 'getpaid_subscription_email_recipients', wpinv_parse_list( $recipients ), $email ),
-			$subject,
-			$content,
-			$attachments
-		);
-
-		// Maybe send a copy to the admin.
-		if ( $email->include_admin_bcc() ) {
-			$mailer->send(
-				wpinv_get_admin_email(),
-				$subject . __( ' - ADMIN BCC COPY', 'invoicing' ),
-				$content,
-				$attachments
-			);
-		}
-
-		if ( $result ) {
-			$subscription->get_parent_invoice()->add_note( sprintf( __( 'Successfully sent %s notification email.', 'invoicing' ), sanitize_key( $type ) ), false, false, true );
-		} else {
-			$subscription->get_parent_invoice()->add_note( sprintf( __( 'Failed sending %s notification email.', 'invoicing' ), sanitize_key( $type ) ), false, false, true );
-		}
-
-		do_action( 'getpaid_after_send_subscription_notification', $type, $subscription, $email );
-
-	}
+     * Registers email hooks.
+     */
+    public function init_hooks() {
+
+        add_filter( 'getpaid_get_email_merge_tags', array( $this, 'subscription_merge_tags' ), 10, 2 );
+        foreach ( $this->subscription_actions as $hook => $email_type ) {
+
+            $email = new GetPaid_Notification_Email( $email_type );
+
+            if ( ! $email->is_active() ) {
+                continue;
+            }
+
+            if ( method_exists( $this, $email_type ) ) {
+                add_action( $hook, array( $this, $email_type ), 100, 2 );
+                continue;
+            }
+
+            do_action( 'getpaid_subscription_notification_email_register_hook', $email_type, $hook );
+
+        }
+
+    }
 
     /**
-	 * Sends a new trial notification.
-	 *
-	 * @param WPInv_Subscription $subscription
-	 */
-	public function subscription_trial( $subscription ) {
+     * Filters subscription merge tags.
+     *
+     * @param array $merge_tags
+     * @param mixed|WPInv_Invoice|WPInv_Subscription $object
+     */
+    public function subscription_merge_tags( $merge_tags, $object ) {
 
-		$email     = new GetPaid_Notification_Email( __FUNCTION__, $subscription );
-		$this->send_email( $subscription, $email, __FUNCTION__ );
+        if ( is_a( $object, 'WPInv_Subscription' ) ) {
+            $merge_tags = array_merge(
+                $merge_tags,
+                $this->get_subscription_merge_tags( $object )
+            );
+        }
 
-	}
+        return $merge_tags;
 
-	/**
-	 * Sends a cancelled subscription notification.
-	 *
-	 * @param WPInv_Subscription $subscription
-	 */
-	public function subscription_cancelled( $subscription ) {
+    }
 
-		$email     = new GetPaid_Notification_Email( __FUNCTION__, $subscription );
-		$this->send_email( $subscription, $email, __FUNCTION__ );
+    /**
+     * Generates subscription merge tags.
+     *
+     * @param WPInv_Subscription $subscription
+     * @return array
+     */
+    public function get_subscription_merge_tags( $subscription ) {
+
+        // Abort if it does not exist.
+        if ( ! $subscription->get_id() ) {
+            return array();
+        }
+
+        $invoice    = $subscription->get_parent_invoice();
+        return array(
+            '{subscription_renewal_date}'     => getpaid_format_date_value( $subscription->get_next_renewal_date(), __( 'Never', 'invoicing' ) ),
+            '{subscription_created}'          => getpaid_format_date_value( $subscription->get_date_created() ),
+            '{subscription_status}'           => sanitize_text_field( $subscription->get_status_label() ),
+            '{subscription_profile_id}'       => sanitize_text_field( $subscription->get_profile_id() ),
+            '{subscription_id}'               => absint( $subscription->get_id() ),
+            '{subscription_recurring_amount}' => sanitize_text_field( wpinv_price( $subscription->get_recurring_amount(), $invoice->get_currency() ) ),
+            '{subscription_initial_amount}'   => sanitize_text_field( wpinv_price( $subscription->get_initial_amount(), $invoice->get_currency() ) ),
+            '{subscription_recurring_period}' => getpaid_get_subscription_period_label( $subscription->get_period(), $subscription->get_frequency(), '' ),
+            '{subscription_bill_times}'       => $subscription->get_bill_times(),
+            '{subscription_url}'              => esc_url( $subscription->get_view_url() ),
+        );
 
-	}
+    }
 
-	/**
-	 * Sends a subscription expired notification.
-	 *
-	 * @param WPInv_Subscription $subscription
-	 */
-	public function subscription_expired( $subscription ) {
+    /**
+     * Checks if we should send a notification for a subscription.
+     *
+     * @param WPInv_Invoice $invoice
+     * @return bool
+     */
+    public function should_send_notification( $invoice ) {
+        return 0 != $invoice->get_id();
+    }
 
-		$email     = new GetPaid_Notification_Email( __FUNCTION__, $subscription );
-		$this->send_email( $subscription, $email, __FUNCTION__ );
+    /**
+     * Returns notification recipients.
+     *
+     * @param WPInv_Invoice $invoice
+     * @return array
+     */
+    public function get_recipients( $invoice ) {
+        $recipients = array( $invoice->get_email() );
 
-	}
+        $cc = $invoice->get_email_cc();
 
-	/**
-	 * Sends a completed subscription notification.
-	 *
-	 * @param WPInv_Subscription $subscription
-	 */
-	public function subscription_complete( $subscription ) {
+        if ( ! empty( $cc ) ) {
+            $cc = array_map( 'sanitize_email', wpinv_parse_list( $cc ) );
+            $recipients = array_filter( array_unique( array_merge( $recipients, $cc ) ) );
+        }
 
-		$email     = new GetPaid_Notification_Email( __FUNCTION__, $subscription );
-		$this->send_email( $subscription, $email, __FUNCTION__ );
+        return $recipients;
+    }
 
-	}
+    /**
+     * Helper function to send an email.
+     *
+     * @param WPInv_Subscription $subscription
+     * @param GetPaid_Notification_Email $email
+     * @param string $type
+     * @param array $extra_args Extra template args.
+     */
+    public function send_email( $subscription, $email, $type, $extra_args = array() ) {
+
+        // Abort in case the parent invoice does not exist.
+        $invoice = $subscription->get_parent_invoice();
+        if ( ! $this->should_send_notification( $invoice ) ) {
+            return;
+        }
+
+        if ( apply_filters( 'getpaid_skip_subscription_email', false, $type, $subscription ) ) {
+            return;
+        }
+
+        do_action( 'getpaid_before_send_subscription_notification', $type, $subscription, $email );
+
+        $recipients  = $this->get_recipients( $invoice );
+        $mailer      = new GetPaid_Notification_Email_Sender();
+        $merge_tags  = $email->get_merge_tags();
+        $content     = $email->get_content( $merge_tags, $extra_args );
+        $subject     = $email->add_merge_tags( $email->get_subject(), $merge_tags );
+        $attachments = $email->get_attachments();
+
+        $result = $mailer->send(
+            apply_filters( 'getpaid_subscription_email_recipients', wpinv_parse_list( $recipients ), $email ),
+            $subject,
+            $content,
+            $attachments
+        );
+
+        // Maybe send a copy to the admin.
+        if ( $email->include_admin_bcc() ) {
+            $mailer->send(
+                wpinv_get_admin_email(),
+                $subject . __( ' - ADMIN BCC COPY', 'invoicing' ),
+                $content,
+                $attachments
+            );
+        }
+
+        if ( $result ) {
+            $subscription->get_parent_invoice()->add_note( sprintf( __( 'Successfully sent %s notification email.', 'invoicing' ), sanitize_key( $type ) ), false, false, true );
+        } else {
+            $subscription->get_parent_invoice()->add_note( sprintf( __( 'Failed sending %s notification email.', 'invoicing' ), sanitize_key( $type ) ), false, false, true );
+        }
+
+        do_action( 'getpaid_after_send_subscription_notification', $type, $subscription, $email );
 
-	/**
-	 * Sends a subscription renewal reminder notification.
-	 *
-	 */
-	public function renewal_reminder() {
+    }
 
-		$email = new GetPaid_Notification_Email( __FUNCTION__ );
+    /**
+     * Sends a new trial notification.
+     *
+     * @param WPInv_Subscription $subscription
+     */
+    public function subscription_trial( $subscription ) {
 
-		// Fetch reminder days.
-		$reminder_days = array_unique( wp_parse_id_list( $email->get_option( 'days' ) ) );
+        $email     = new GetPaid_Notification_Email( __FUNCTION__, $subscription );
+        $this->send_email( $subscription, $email, __FUNCTION__ );
 
-		// Abort if non is set.
-		if ( empty( $reminder_days ) ) {
-			return;
-		}
+    }
 
-		// Fetch matching subscriptions.
+    /**
+     * Sends a cancelled subscription notification.
+     *
+     * @param WPInv_Subscription $subscription
+     */
+    public function subscription_cancelled( $subscription ) {
+
+        $email     = new GetPaid_Notification_Email( __FUNCTION__, $subscription );
+        $this->send_email( $subscription, $email, __FUNCTION__ );
+
+    }
+
+    /**
+     * Sends a subscription expired notification.
+     *
+     * @param WPInv_Subscription $subscription
+     */
+    public function subscription_expired( $subscription ) {
+
+        $email     = new GetPaid_Notification_Email( __FUNCTION__, $subscription );
+        $this->send_email( $subscription, $email, __FUNCTION__ );
+
+    }
+
+    /**
+     * Sends a completed subscription notification.
+     *
+     * @param WPInv_Subscription $subscription
+     */
+    public function subscription_complete( $subscription ) {
+
+        $email     = new GetPaid_Notification_Email( __FUNCTION__, $subscription );
+        $this->send_email( $subscription, $email, __FUNCTION__ );
+
+    }
+
+    /**
+     * Sends a subscription renewal reminder notification.
+     *
+     */
+    public function renewal_reminder() {
+
+        $email = new GetPaid_Notification_Email( __FUNCTION__ );
+
+        // Fetch reminder days.
+        $reminder_days = array_unique( wp_parse_id_list( $email->get_option( 'days' ) ) );
+
+        // Abort if non is set.
+        if ( empty( $reminder_days ) ) {
+            return;
+        }
+
+        // Fetch matching subscriptions.
         $args  = array(
             'number'             => -1,
-			'count_total'        => false,
-			'status'             => 'trialling active',
+            'count_total'        => false,
+            'status'             => 'trialling active',
             'date_expires_query' => array(
-				'relation'  => 'OR'
+                'relation'  => 'OR'
             ),
-		);
+        );
 
-		foreach ( $reminder_days as $days ) {
-			$date = date_parse( date( 'Y-m-d', strtotime( "+$days days", current_time( 'timestamp' ) ) ) );
+        foreach ( $reminder_days as $days ) {
+            $date = date_parse( date( 'Y-m-d', strtotime( "+$days days", current_time( 'timestamp' ) ) ) );
 
-			$args['date_expires_query'][] = array(
-				'year'  => $date['year'],
-				'month' => $date['month'],
-				'day'   => $date['day'],
-			);
+            $args['date_expires_query'][] = array(
+                'year'  => $date['year'],
+                'month' => $date['month'],
+                'day'   => $date['day'],
+            );
 
-		}
+        }
 
-		$subscriptions = new GetPaid_Subscriptions_Query( $args );
+        $subscriptions = new GetPaid_Subscriptions_Query( $args );
 
         foreach ( $subscriptions as $subscription ) {
 
-			// Skip packages.
-			if ( get_post_meta( $subscription->get_product_id(), '_wpinv_type', true ) != 'package' ) {
-				$email->object = $subscription;
-            	$this->send_email( $subscription, $email, __FUNCTION__ );
-			}
+            // Skip packages.
+            if ( get_post_meta( $subscription->get_product_id(), '_wpinv_type', true ) != 'package' ) {
+                $email->object = $subscription;
+                $this->send_email( $subscription, $email, __FUNCTION__ );
+            }
 
-		}
+        }
 
-	}
+    }
 
 }

includes/wpinv-item-functions.php

Indentation +3 added lines, -3 removed lines

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

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

Indentation +41 added lines, -41 removed lines

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

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

Indentation +154 added lines, -154 removed lines

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

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

Indentation +276 added lines, -276 removed lines

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

includes/class-wpinv-notes.php

Indentation +192 added lines, -192 removed lines

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