AyeCode / invoicing

includes/class-wpinv-subscriptions.php

Indentation +4 added lines, -4 removed lines

@@ -12,8 +12,8 @@ 
 class WPInv_Subscriptions {
 
     /**
-	 * Class constructor.
-	 */
+     * Class constructor.
+     */
     public function __construct(){
 
         // Fire gateway specific hooks when a subscription changes.
@@ -33,12 +33,12 @@ 
     }
 
     /**
-	 * Processes subscription status changes.
+     * Processes subscription status changes.
      * 
      * @param WPInv_Subscription $subscription
      * @param string $from
      * @param string $to
-	 */
+     */
     public function process_subscription_status_change( $subscription, $from, $to ) {
 
         $gateway = $subscription->get_gateway();

Spacing +106 added lines, -106 removed lines

@@ -4,7 +4,7 @@ 
  *
  */
 
-defined( 'ABSPATH' ) || exit;
+defined('ABSPATH') || exit;
 /**
  * Main Subscriptions class.
  *
@@ -14,31 +14,31 @@ 
     /**
 	 * Class constructor.
 	 */
-    public function __construct(){
+    public function __construct() {
 
         // Fire gateway specific hooks when a subscription changes.
-        add_action( 'getpaid_subscription_status_changed', array( $this, 'process_subscription_status_change' ), 10, 3 );
+        add_action('getpaid_subscription_status_changed', array($this, 'process_subscription_status_change'), 10, 3);
 
         // De-activate a subscription whenever the invoice changes payment statuses.
-        add_action( 'getpaid_invoice_status_wpi-refunded', array( $this, 'maybe_deactivate_invoice_subscription' ), 20 );
-        add_action( 'getpaid_invoice_status_wpi-failed', array( $this, 'maybe_deactivate_invoice_subscription' ), 20 );
-        add_action( 'getpaid_invoice_status_wpi-cancelled', array( $this, 'maybe_deactivate_invoice_subscription' ), 20 );
-        add_action( 'getpaid_invoice_status_wpi-pending', array( $this, 'maybe_deactivate_invoice_subscription' ), 20 );
+        add_action('getpaid_invoice_status_wpi-refunded', array($this, 'maybe_deactivate_invoice_subscription'), 20);
+        add_action('getpaid_invoice_status_wpi-failed', array($this, 'maybe_deactivate_invoice_subscription'), 20);
+        add_action('getpaid_invoice_status_wpi-cancelled', array($this, 'maybe_deactivate_invoice_subscription'), 20);
+        add_action('getpaid_invoice_status_wpi-pending', array($this, 'maybe_deactivate_invoice_subscription'), 20);
 
         // Handles subscription cancelations.
-        add_action( 'getpaid_authenticated_action_subscription_cancel', array( $this, 'user_cancel_single_subscription' ) );
+        add_action('getpaid_authenticated_action_subscription_cancel', array($this, 'user_cancel_single_subscription'));
 
         // Create a subscription whenever an invoice is created, (and update it when it is updated).
-        add_action( 'getpaid_new_invoice', array( $this, 'maybe_create_invoice_subscription' ) );
-        add_action( 'getpaid_update_invoice', array( $this, 'maybe_update_invoice_subscription' ) );
+        add_action('getpaid_new_invoice', array($this, 'maybe_create_invoice_subscription'));
+        add_action('getpaid_update_invoice', array($this, 'maybe_update_invoice_subscription'));
 
         // Handles admin subscription update actions.
-        add_action( 'getpaid_authenticated_admin_action_update_single_subscription', array( $this, 'admin_update_single_subscription' ) );
-        add_action( 'getpaid_authenticated_admin_action_subscription_manual_renew', array( $this, 'admin_renew_single_subscription' ) );
-        add_action( 'getpaid_authenticated_admin_action_subscription_manual_delete', array( $this, 'admin_delete_single_subscription' ) );
+        add_action('getpaid_authenticated_admin_action_update_single_subscription', array($this, 'admin_update_single_subscription'));
+        add_action('getpaid_authenticated_admin_action_subscription_manual_renew', array($this, 'admin_renew_single_subscription'));
+        add_action('getpaid_authenticated_admin_action_subscription_manual_delete', array($this, 'admin_delete_single_subscription'));
     
         // Filter invoice item row actions.
-        add_action( 'getpaid-invoice-page-line-item-actions', array( $this, 'filter_invoice_line_item_actions' ), 10, 3 );
+        add_action('getpaid-invoice-page-line-item-actions', array($this, 'filter_invoice_line_item_actions'), 10, 3);
     }
 
     /**
@@ -47,19 +47,19 @@ 
      * @param WPInv_Invoice $invoice
      * @return WPInv_Subscription|bool
      */
-    public function get_invoice_subscription( $invoice ) {
+    public function get_invoice_subscription($invoice) {
         $subscription_id = $invoice->get_subscription_id();
 
         // Fallback to the parent invoice if the child invoice has no subscription id.
-        if ( empty( $subscription_id && $invoice->is_renewal() ) ) {
+        if (empty($subscription_id && $invoice->is_renewal())) {
             $subscription_id = $invoice->get_parent_payment()->get_subscription_id();
         }
 
         // Fetch the subscription.
-        $subscription = new WPInv_Subscription( $subscription_id );
+        $subscription = new WPInv_Subscription($subscription_id);
 
         // Return subscription or use a fallback for backwards compatibility.
-        return $subscription->get_id() ? $subscription : wpinv_get_subscription( $invoice );
+        return $subscription->get_id() ? $subscription : wpinv_get_subscription($invoice);
     }
 
     /**
@@ -67,16 +67,16 @@ 
      * 
      * @param WPInv_Invoice $invoice
      */
-    public function maybe_deactivate_invoice_subscription( $invoice ) {
+    public function maybe_deactivate_invoice_subscription($invoice) {
 
-        $subscription = $this->get_invoice_subscription( $invoice );
+        $subscription = $this->get_invoice_subscription($invoice);
 
         // Abort if the subscription is missing or not active.
-        if ( empty( $subscription ) || ! $subscription->is_active() ) {
+        if (empty($subscription) || !$subscription->is_active()) {
             return;
         }
 
-        $subscription->set_status( 'pending' );
+        $subscription->set_status('pending');
         $subscription->save();
 
     }
@@ -88,15 +88,15 @@ 
      * @param string $from
      * @param string $to
 	 */
-    public function process_subscription_status_change( $subscription, $from, $to ) {
+    public function process_subscription_status_change($subscription, $from, $to) {
 
         $gateway = $subscription->get_gateway();
 
-        if ( ! empty( $gateway ) ) {
-            $gateway = sanitize_key( $gateway );
-            $from    = sanitize_key( $from );
-            $to      = sanitize_key( $to );
-            do_action( "getpaid_{$gateway}_subscription_$to", $subscription, $from );
+        if (!empty($gateway)) {
+            $gateway = sanitize_key($gateway);
+            $from    = sanitize_key($from);
+            $to      = sanitize_key($to);
+            do_action("getpaid_{$gateway}_subscription_$to", $subscription, $from);
         }
 
     }
@@ -109,8 +109,8 @@ 
      * @deprecated
      * @return mixed|string|void
      */
-    public static function wpinv_get_pretty_subscription_frequency( $period, $frequency_count = 1 ) {
-        return getpaid_get_subscription_period_label( $period, $frequency_count );
+    public static function wpinv_get_pretty_subscription_frequency($period, $frequency_count = 1) {
+        return getpaid_get_subscription_period_label($period, $frequency_count);
     }
 
     /**
@@ -120,34 +120,34 @@ 
      * @since       1.0.0
      * @return      void
      */
-    public function user_cancel_single_subscription( $data ) {
+    public function user_cancel_single_subscription($data) {
 
         // Ensure there is a subscription to cancel.
-        if ( empty( $data['subscription'] ) ) {
+        if (empty($data['subscription'])) {
             return;
         }
 
-        $subscription = new WPInv_Subscription( (int) $data['subscription'] );
+        $subscription = new WPInv_Subscription((int) $data['subscription']);
 
         // Ensure that it exists and that it belongs to the current user.
-        if ( ! $subscription->get_id() || $subscription->get_customer_id() != get_current_user_id() ) {
-            wpinv_set_error( 'invalid_subscription', __( 'You do not have permission to cancel this subscription', 'invoicing' ) );
+        if (!$subscription->get_id() || $subscription->get_customer_id() != get_current_user_id()) {
+            wpinv_set_error('invalid_subscription', __('You do not have permission to cancel this subscription', 'invoicing'));
 
         // Can it be cancelled.
-        } else if ( ! $subscription->can_cancel() ) {
-            wpinv_set_error( 'cannot_cancel', __( 'This subscription cannot be cancelled as it is not active.', 'invoicing' ) );
+        } else if (!$subscription->can_cancel()) {
+            wpinv_set_error('cannot_cancel', __('This subscription cannot be cancelled as it is not active.', 'invoicing'));
 
 
         // Cancel it.
         } else {
 
             $subscription->cancel();
-            wpinv_set_error( 'cancelled', __( 'This subscription has been cancelled.', 'invoicing' ), 'info' );
+            wpinv_set_error('cancelled', __('This subscription has been cancelled.', 'invoicing'), 'info');
         }
 
-        $redirect = remove_query_arg( array( 'getpaid-action', 'getpaid-nonce' ) );
+        $redirect = remove_query_arg(array('getpaid-action', 'getpaid-nonce'));
 
-        wp_safe_redirect( $redirect );
+        wp_safe_redirect($redirect);
         exit;
 
     }
@@ -159,15 +159,15 @@ 
      * @param       WPInv_Invoice $invoice
      * @since       1.0.0
      */
-    public function maybe_create_invoice_subscription( $invoice ) {
+    public function maybe_create_invoice_subscription($invoice) {
 
         // Abort if it is not recurring.
-        if ( $invoice->is_free() || ! $invoice->is_recurring() || $invoice->is_renewal() ) {
+        if ($invoice->is_free() || !$invoice->is_recurring() || $invoice->is_renewal()) {
             return;
         }
 
         $subscription = new WPInv_Subscription();
-        return $this->update_invoice_subscription( $subscription, $invoice );
+        return $this->update_invoice_subscription($subscription, $invoice);
 
     }
 
@@ -178,32 +178,32 @@ 
      * @param       WPInv_Invoice $invoice
      * @since       1.0.19
      */
-    public function maybe_update_invoice_subscription( $invoice ) {
+    public function maybe_update_invoice_subscription($invoice) {
 
         // Do not process renewals.
-        if ( $invoice->is_renewal() ) {
+        if ($invoice->is_renewal()) {
             return;
         }
 
         // Delete existing subscription if available and the invoice is not recurring.
-        if ( ! $invoice->is_recurring() ) {
-            $subscription = new WPInv_Subscription( $invoice->get_subscription_id() );
-            $subscription->delete( true );
+        if (!$invoice->is_recurring()) {
+            $subscription = new WPInv_Subscription($invoice->get_subscription_id());
+            $subscription->delete(true);
             return;
         }
 
         // (Maybe) create a new subscription.
-        $subscription = $this->get_invoice_subscription( $invoice );
-        if ( empty( $subscription ) ) {
-            return $this->maybe_create_invoice_subscription( $invoice );
+        $subscription = $this->get_invoice_subscription($invoice);
+        if (empty($subscription)) {
+            return $this->maybe_create_invoice_subscription($invoice);
         }
 
         // Abort if an invoice is paid and already has a subscription.
-        if ( $invoice->is_paid() || $invoice->is_refunded() ) {
+        if ($invoice->is_paid() || $invoice->is_refunded()) {
             return;
         }
 
-        return $this->update_invoice_subscription( $subscription, $invoice );
+        return $this->update_invoice_subscription($subscription, $invoice);
 
     }
 
@@ -215,57 +215,57 @@ 
      * @param       WPInv_Invoice $invoice
      * @since       1.0.19
      */
-    public function update_invoice_subscription( $subscription, $invoice ) {
+    public function update_invoice_subscription($subscription, $invoice) {
 
         // Delete the subscription if an invoice is free or nolonger recurring.
-        if ( ! $invoice->is_type( 'invoice' ) || $invoice->is_free() || ! $invoice->is_recurring() ) {
+        if (!$invoice->is_type('invoice') || $invoice->is_free() || !$invoice->is_recurring()) {
             return $subscription->delete();
         }
 
-        $subscription->set_customer_id( $invoice->get_customer_id() );
-        $subscription->set_parent_invoice_id( $invoice->get_id() );
-        $subscription->set_initial_amount( $invoice->get_initial_total() );
-        $subscription->set_recurring_amount( $invoice->get_recurring_total() );
-        $subscription->set_date_created( current_time( 'mysql' ) );
-        $subscription->set_status( $invoice->is_paid() ? 'active' : 'pending' );
+        $subscription->set_customer_id($invoice->get_customer_id());
+        $subscription->set_parent_invoice_id($invoice->get_id());
+        $subscription->set_initial_amount($invoice->get_initial_total());
+        $subscription->set_recurring_amount($invoice->get_recurring_total());
+        $subscription->set_date_created(current_time('mysql'));
+        $subscription->set_status($invoice->is_paid() ? 'active' : 'pending');
 
         // Get the recurring item and abort if it does not exist.
-        $subscription_item = $invoice->get_recurring( true );
-        if ( ! $subscription_item->get_id() ) {
+        $subscription_item = $invoice->get_recurring(true);
+        if (!$subscription_item->get_id()) {
             $invoice->set_subscription_id(0);
             $invoice->save();
             return $subscription->delete();
         }
 
-        $subscription->set_product_id( $subscription_item->get_id() );
-        $subscription->set_period( $subscription_item->get_recurring_period( true ) );
-        $subscription->set_frequency( $subscription_item->get_recurring_interval() );
-        $subscription->set_bill_times( $subscription_item->get_recurring_limit() );
+        $subscription->set_product_id($subscription_item->get_id());
+        $subscription->set_period($subscription_item->get_recurring_period(true));
+        $subscription->set_frequency($subscription_item->get_recurring_interval());
+        $subscription->set_bill_times($subscription_item->get_recurring_limit());
 
         // Calculate the next renewal date.
-        $period       = $subscription_item->get_recurring_period( true );
+        $period       = $subscription_item->get_recurring_period(true);
         $interval     = $subscription_item->get_recurring_interval();
 
         // If the subscription item has a trial period...
-        if ( $subscription_item->has_free_trial() ) {
-            $period   = $subscription_item->get_trial_period( true );
+        if ($subscription_item->has_free_trial()) {
+            $period   = $subscription_item->get_trial_period(true);
             $interval = $subscription_item->get_trial_interval();
-            $subscription->set_trial_period( $interval . ' ' . $period );
-            $subscription->set_status( 'trialling' );
+            $subscription->set_trial_period($interval . ' ' . $period);
+            $subscription->set_status('trialling');
         }
 
         // If initial amount is free, treat it as a free trial even if the subscription item does not have a free trial.
-        if ( $invoice->has_free_trial() ) {
-            $subscription->set_trial_period( $interval . ' ' . $period );
-            $subscription->set_status( 'trialling' );
+        if ($invoice->has_free_trial()) {
+            $subscription->set_trial_period($interval . ' ' . $period);
+            $subscription->set_status('trialling');
         }
 
         // Calculate the next renewal date.
-        $expiration = date( 'Y-m-d H:i:s', strtotime( "+$interval $period", strtotime( $subscription->get_date_created() ) ) );
+        $expiration = date('Y-m-d H:i:s', strtotime("+$interval $period", strtotime($subscription->get_date_created())));
 
-        $subscription->set_next_renewal_date( $expiration );
+        $subscription->set_next_renewal_date($expiration);
         $subscription->save();
-        $invoice->set_subscription_id( $subscription->get_id() );
+        $invoice->set_subscription_id($subscription->get_id());
         return $subscription->get_id();
 
     }
@@ -276,21 +276,21 @@ 
      * @param       array $data
      * @since       1.0.19
      */
-    public function admin_update_single_subscription( $args ) {
+    public function admin_update_single_subscription($args) {
 
         // Ensure the subscription exists and that a status has been given.
-        if ( empty( $args['subscription_id'] ) || empty( $args['subscription_status'] ) ) {
+        if (empty($args['subscription_id']) || empty($args['subscription_status'])) {
             return;
         }
 
         // Retrieve the subscriptions.
-        $subscription = new WPInv_Subscription( $args['subscription_id'] );
+        $subscription = new WPInv_Subscription($args['subscription_id']);
 
-        if ( $subscription->get_id() ) {
+        if ($subscription->get_id()) {
 
-            $subscription->set_status( $args['subscription_status'] );
+            $subscription->set_status($args['subscription_status']);
             $subscription->save();
-            getpaid_admin()->show_info( __( 'Your changes have been saved', 'invoicing' ) );
+            getpaid_admin()->show_info(__('Your changes have been saved', 'invoicing'));
 
         }
 
@@ -302,27 +302,27 @@ 
      * @param       array $data
      * @since       1.0.19
      */
-    public function admin_renew_single_subscription( $args ) {
+    public function admin_renew_single_subscription($args) {
 
         // Ensure the subscription exists and that a status has been given.
-        if ( empty( $args['id'] ) ) {
+        if (empty($args['id'])) {
             return;
         }
 
         // Retrieve the subscriptions.
-        $subscription = new WPInv_Subscription( $args['id'] );
+        $subscription = new WPInv_Subscription($args['id']);
 
-        if ( $subscription->get_id() ) {
+        if ($subscription->get_id()) {
 
-            do_action( 'getpaid_admin_renew_subscription', $subscription );
+            do_action('getpaid_admin_renew_subscription', $subscription);
 
-            $args = array( 'transaction_id', $subscription->get_parent_invoice()->generate_key( 'renewal_' ) );
+            $args = array('transaction_id', $subscription->get_parent_invoice()->generate_key('renewal_'));
 
-            if ( ! $subscription->add_payment( $args ) ) {
-                getpaid_admin()->show_error( __( 'We are unable to renew this subscription as the parent invoice does not exist.', 'invoicing' ) );
+            if (!$subscription->add_payment($args)) {
+                getpaid_admin()->show_error(__('We are unable to renew this subscription as the parent invoice does not exist.', 'invoicing'));
             } else {
                 $subscription->renew();
-                getpaid_admin()->show_info( __( 'This subscription has been renewed and extended.', 'invoicing' ) );
+                getpaid_admin()->show_info(__('This subscription has been renewed and extended.', 'invoicing'));
             } 
 
             wp_safe_redirect(
@@ -345,20 +345,20 @@ 
      * @param       array $data
      * @since       1.0.19
      */
-    public function admin_delete_single_subscription( $args ) {
+    public function admin_delete_single_subscription($args) {
 
         // Ensure the subscription exists and that a status has been given.
-        if ( empty( $args['id'] ) ) {
+        if (empty($args['id'])) {
             return;
         }
 
         // Retrieve the subscriptions.
-        $subscription = new WPInv_Subscription( $args['id'] );
+        $subscription = new WPInv_Subscription($args['id']);
 
-        if ( $subscription->delete() ) {
-            getpaid_admin()->show_info( __( 'This subscription has been deleted.', 'invoicing' ) );
+        if ($subscription->delete()) {
+            getpaid_admin()->show_info(__('This subscription has been deleted.', 'invoicing'));
         } else {
-            getpaid_admin()->show_error( __( 'We are unable to delete this subscription. Please try again.', 'invoicing' ) );
+            getpaid_admin()->show_error(__('We are unable to delete this subscription. Please try again.', 'invoicing'));
         }
     
         $redirected = wp_safe_redirect(
@@ -371,7 +371,7 @@ 
             )
         );
 
-        if ( $redirected ) {
+        if ($redirected) {
             exit;
         }
 
@@ -384,10 +384,10 @@ 
      * @param WPInv_Item $item
      * @param WPInv_Invoice $invoice
      */
-    public function filter_invoice_line_item_actions( $actions, $item, $invoice ) {
+    public function filter_invoice_line_item_actions($actions, $item, $invoice) {
 
         // Fetch item subscription.
-        $args  = array(
+        $args = array(
             'invoice_in'  => $invoice->is_parent() ? $invoice->get_id() : $invoice->get_parent_id(),
             'product_in'  => $item->get_id(),
             'number'      => 1,
@@ -395,13 +395,13 @@ 
             'fields'      => 'id',
         );
 
-        $subscription = new GetPaid_Subscriptions_Query( $args );
+        $subscription = new GetPaid_Subscriptions_Query($args);
         $subscription = $subscription->get_results();
 
         // In case we found a match...
-        if ( ! empty( $subscription ) ) {
-            $url                     = esc_url( add_query_arg( 'subscription', (int) $subscription[0], get_permalink( (int) wpinv_get_option( 'invoice_subscription_page' ) ) ) );
-            $actions['subscription'] = "<a href='$url' class='text-decoration-none'>" . __( 'Manage Subscription', 'invoicing' ) . '</a>';
+        if (!empty($subscription)) {
+            $url                     = esc_url(add_query_arg('subscription', (int) $subscription[0], get_permalink((int) wpinv_get_option('invoice_subscription_page'))));
+            $actions['subscription'] = "<a href='$url' class='text-decoration-none'>" . __('Manage Subscription', 'invoicing') . '</a>';
         }
 
         return $actions;

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

Indentation +169 added lines, -169 removed lines

@@ -4,7 +4,7 @@ 
  *
  */
 if ( ! defined( 'ABSPATH' ) ) {
-	exit;
+    exit;
 }
 
 /**
@@ -14,179 +14,179 @@ 
  */
 class GetPaid_Payment_Form_Data_Store extends GetPaid_Data_Store_WP {
 
-	/**
-	 * Data stored in meta keys, but not considered "meta" for a form.
-	 *
-	 * @since 1.0.19
-	 * @var array
-	 */
-	protected $internal_meta_keys = array(
-		'wpinv_form_elements',
-		'wpinv_form_items',
-		'wpinv_form_earned',
-		'wpinv_form_refunded',
-		'wpinv_form_cancelled',
-		'wpinv_form_failed'
-	);
-
-	/**
-	 * A map of meta keys to data props.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @var array
-	 */
-	protected $meta_key_to_props = array(
-		'wpinv_form_elements'  => 'elements',
-		'wpinv_form_items'     => 'items',
-		'wpinv_form_earned'    => 'earned',
-		'wpinv_form_refunded'  => 'refunded',
-		'wpinv_form_cancelled' => 'cancelled',
-		'wpinv_form_failed'    => 'failed',
-	);
-
-	/*
+    /**
+     * Data stored in meta keys, but not considered "meta" for a form.
+     *
+     * @since 1.0.19
+     * @var array
+     */
+    protected $internal_meta_keys = array(
+        'wpinv_form_elements',
+        'wpinv_form_items',
+        'wpinv_form_earned',
+        'wpinv_form_refunded',
+        'wpinv_form_cancelled',
+        'wpinv_form_failed'
+    );
+
+    /**
+     * A map of meta keys to data props.
+     *
+     * @since 1.0.19
+     *
+     * @var array
+     */
+    protected $meta_key_to_props = array(
+        'wpinv_form_elements'  => 'elements',
+        'wpinv_form_items'     => 'items',
+        'wpinv_form_earned'    => 'earned',
+        'wpinv_form_refunded'  => 'refunded',
+        'wpinv_form_cancelled' => 'cancelled',
+        'wpinv_form_failed'    => 'failed',
+    );
+
+    /*
 	|--------------------------------------------------------------------------
 	| CRUD Methods
 	|--------------------------------------------------------------------------
 	*/
 
-	/**
-	 * Method to create a new form in the database.
-	 *
-	 * @param GetPaid_Payment_Form $form Form object.
-	 */
-	public function create( &$form ) {
-		$form->set_version( WPINV_VERSION );
-		$form->set_date_created( current_time('mysql') );
-
-		// Create a new post.
-		$id = wp_insert_post(
-			apply_filters(
-				'getpaid_new_payment_form_data',
-				array(
-					'post_date'     => $form->get_date_created( 'edit' ),
-					'post_type'     => 'wpi_payment_form',
-					'post_status'   => $this->get_post_status( $form ),
-					'ping_status'   => 'closed',
-					'post_author'   => $form->get_author( 'edit' ),
-					'post_title'    => $form->get_name( 'edit' ),
-				)
-			),
-			true
-		);
-
-		if ( $id && ! is_wp_error( $id ) ) {
-			$form->set_id( $id );
-			$this->update_post_meta( $form );
-			$form->save_meta_data();
-			$form->apply_changes();
-			$this->clear_caches( $form );
-			do_action( 'getpaid_create_payment_form', $form );
-			return true;
-		}
-
-		if ( is_wp_error( $id ) ) {
-			$form->last_error = $id->get_error_message();
-		}
-
-		return false;
-	}
-
-	/**
-	 * Method to read a form from the database.
-	 *
-	 * @param GetPaid_Payment_Form $form Form object.
-	 *
-	 */
-	public function read( &$form ) {
-
-		$form->set_defaults();
-		$form_object = get_post( $form->get_id() );
-
-		if ( ! $form->get_id() || ! $form_object || $form_object->post_type != 'wpi_payment_form' ) {
-			$form->last_error = __( 'Invalid form.', 'invoicing' );
-			$form->set_id( 0 );
-			return false;
-		}
-
-		$form->set_props(
-			array(
-				'date_created'  => 0 < $form_object->post_date ? $form_object->post_date : null,
-				'date_modified' => 0 < $form_object->post_modified ? $form_object->post_modified : null,
-				'status'        => $form_object->post_status,
-				'name'          => $form_object->post_title,
-				'author'        => $form_object->post_author,
-			)
-		);
-
-		$this->read_object_data( $form, $form_object );
-		$form->read_meta_data();
-		$form->set_object_read( true );
-		do_action( 'getpaid_read_payment_form', $form );
-
-	}
-
-	/**
-	 * Method to update a form in the database.
-	 *
-	 * @param GetPaid_Payment_Form $form Form object.
-	 */
-	public function update( &$form ) {
-		$form->save_meta_data();
-		$form->set_version( WPINV_VERSION );
-
-		if ( null === $form->get_date_created( 'edit' ) ) {
-			$form->set_date_created(  current_time('mysql') );
-		}
-
-		// Grab the current status so we can compare.
-		$previous_status = get_post_status( $form->get_id() );
-
-		$changes = $form->get_changes();
-
-		// Only update the post when the post data changes.
-		if ( array_intersect( array( 'date_created', 'date_modified', 'status', 'name', 'author' ), array_keys( $changes ) ) ) {
-			$post_data = array(
-				'post_date'         => $form->get_date_created( 'edit' ),
-				'post_status'       => $form->get_status( 'edit' ),
-				'post_title'        => $form->get_name( 'edit' ),
-				'post_author'       => $form->get_author( 'edit' ),
-				'post_modified'     => $form->get_date_modified( 'edit' ),
-			);
-
-			/**
-			 * When updating this object, to prevent infinite loops, use $wpdb
-			 * to update data, since wp_update_post spawns more calls to the
-			 * save_post action.
-			 *
-			 * This ensures hooks are fired by either WP itself (admin screen save),
-			 * or an update purely from CRUD.
-			 */
-			if ( doing_action( 'save_post' ) ) {
-				$GLOBALS['wpdb']->update( $GLOBALS['wpdb']->posts, $post_data, array( 'ID' => $form->get_id() ) );
-				clean_post_cache( $form->get_id() );
-			} else {
-				wp_update_post( array_merge( array( 'ID' => $form->get_id() ), $post_data ) );
-			}
-			$form->read_meta_data( true ); // Refresh internal meta data, in case things were hooked into `save_post` or another WP hook.
-		}
-		$this->update_post_meta( $form );
-		$form->apply_changes();
-		$this->clear_caches( $form );
-
-		// Fire a hook depending on the status - this should be considered a creation if it was previously draft status.
-		$new_status = $form->get_status( 'edit' );
-
-		if ( $new_status !== $previous_status && in_array( $previous_status, array( 'new', 'auto-draft', 'draft' ), true ) ) {
-			do_action( 'getpaid_new_payment_form', $form );
-		} else {
-			do_action( 'getpaid_update_payment_form', $form );
-		}
-
-	}
-
-	/*
+    /**
+     * Method to create a new form in the database.
+     *
+     * @param GetPaid_Payment_Form $form Form object.
+     */
+    public function create( &$form ) {
+        $form->set_version( WPINV_VERSION );
+        $form->set_date_created( current_time('mysql') );
+
+        // Create a new post.
+        $id = wp_insert_post(
+            apply_filters(
+                'getpaid_new_payment_form_data',
+                array(
+                    'post_date'     => $form->get_date_created( 'edit' ),
+                    'post_type'     => 'wpi_payment_form',
+                    'post_status'   => $this->get_post_status( $form ),
+                    'ping_status'   => 'closed',
+                    'post_author'   => $form->get_author( 'edit' ),
+                    'post_title'    => $form->get_name( 'edit' ),
+                )
+            ),
+            true
+        );
+
+        if ( $id && ! is_wp_error( $id ) ) {
+            $form->set_id( $id );
+            $this->update_post_meta( $form );
+            $form->save_meta_data();
+            $form->apply_changes();
+            $this->clear_caches( $form );
+            do_action( 'getpaid_create_payment_form', $form );
+            return true;
+        }
+
+        if ( is_wp_error( $id ) ) {
+            $form->last_error = $id->get_error_message();
+        }
+
+        return false;
+    }
+
+    /**
+     * Method to read a form from the database.
+     *
+     * @param GetPaid_Payment_Form $form Form object.
+     *
+     */
+    public function read( &$form ) {
+
+        $form->set_defaults();
+        $form_object = get_post( $form->get_id() );
+
+        if ( ! $form->get_id() || ! $form_object || $form_object->post_type != 'wpi_payment_form' ) {
+            $form->last_error = __( 'Invalid form.', 'invoicing' );
+            $form->set_id( 0 );
+            return false;
+        }
+
+        $form->set_props(
+            array(
+                'date_created'  => 0 < $form_object->post_date ? $form_object->post_date : null,
+                'date_modified' => 0 < $form_object->post_modified ? $form_object->post_modified : null,
+                'status'        => $form_object->post_status,
+                'name'          => $form_object->post_title,
+                'author'        => $form_object->post_author,
+            )
+        );
+
+        $this->read_object_data( $form, $form_object );
+        $form->read_meta_data();
+        $form->set_object_read( true );
+        do_action( 'getpaid_read_payment_form', $form );
+
+    }
+
+    /**
+     * Method to update a form in the database.
+     *
+     * @param GetPaid_Payment_Form $form Form object.
+     */
+    public function update( &$form ) {
+        $form->save_meta_data();
+        $form->set_version( WPINV_VERSION );
+
+        if ( null === $form->get_date_created( 'edit' ) ) {
+            $form->set_date_created(  current_time('mysql') );
+        }
+
+        // Grab the current status so we can compare.
+        $previous_status = get_post_status( $form->get_id() );
+
+        $changes = $form->get_changes();
+
+        // Only update the post when the post data changes.
+        if ( array_intersect( array( 'date_created', 'date_modified', 'status', 'name', 'author' ), array_keys( $changes ) ) ) {
+            $post_data = array(
+                'post_date'         => $form->get_date_created( 'edit' ),
+                'post_status'       => $form->get_status( 'edit' ),
+                'post_title'        => $form->get_name( 'edit' ),
+                'post_author'       => $form->get_author( 'edit' ),
+                'post_modified'     => $form->get_date_modified( 'edit' ),
+            );
+
+            /**
+             * When updating this object, to prevent infinite loops, use $wpdb
+             * to update data, since wp_update_post spawns more calls to the
+             * save_post action.
+             *
+             * This ensures hooks are fired by either WP itself (admin screen save),
+             * or an update purely from CRUD.
+             */
+            if ( doing_action( 'save_post' ) ) {
+                $GLOBALS['wpdb']->update( $GLOBALS['wpdb']->posts, $post_data, array( 'ID' => $form->get_id() ) );
+                clean_post_cache( $form->get_id() );
+            } else {
+                wp_update_post( array_merge( array( 'ID' => $form->get_id() ), $post_data ) );
+            }
+            $form->read_meta_data( true ); // Refresh internal meta data, in case things were hooked into `save_post` or another WP hook.
+        }
+        $this->update_post_meta( $form );
+        $form->apply_changes();
+        $this->clear_caches( $form );
+
+        // Fire a hook depending on the status - this should be considered a creation if it was previously draft status.
+        $new_status = $form->get_status( 'edit' );
+
+        if ( $new_status !== $previous_status && in_array( $previous_status, array( 'new', 'auto-draft', 'draft' ), true ) ) {
+            do_action( 'getpaid_new_payment_form', $form );
+        } else {
+            do_action( 'getpaid_update_payment_form', $form );
+        }
+
+    }
+
+    /*
 	|--------------------------------------------------------------------------
 	| Additional Methods
 	|--------------------------------------------------------------------------

Spacing +44 added lines, -44 removed lines

@@ -3,7 +3,7 @@ 
  * GetPaid_Payment_Form_Data_Store class file.
  *
  */
-if ( ! defined( 'ABSPATH' ) ) {
+if (!defined('ABSPATH')) {
 	exit;
 }
 
@@ -56,37 +56,37 @@ 
 	 *
 	 * @param GetPaid_Payment_Form $form Form object.
 	 */
-	public function create( &$form ) {
-		$form->set_version( WPINV_VERSION );
-		$form->set_date_created( current_time('mysql') );
+	public function create(&$form) {
+		$form->set_version(WPINV_VERSION);
+		$form->set_date_created(current_time('mysql'));
 
 		// Create a new post.
 		$id = wp_insert_post(
 			apply_filters(
 				'getpaid_new_payment_form_data',
 				array(
-					'post_date'     => $form->get_date_created( 'edit' ),
+					'post_date'     => $form->get_date_created('edit'),
 					'post_type'     => 'wpi_payment_form',
-					'post_status'   => $this->get_post_status( $form ),
+					'post_status'   => $this->get_post_status($form),
 					'ping_status'   => 'closed',
-					'post_author'   => $form->get_author( 'edit' ),
-					'post_title'    => $form->get_name( 'edit' ),
+					'post_author'   => $form->get_author('edit'),
+					'post_title'    => $form->get_name('edit'),
 				)
 			),
 			true
 		);
 
-		if ( $id && ! is_wp_error( $id ) ) {
-			$form->set_id( $id );
-			$this->update_post_meta( $form );
+		if ($id && !is_wp_error($id)) {
+			$form->set_id($id);
+			$this->update_post_meta($form);
 			$form->save_meta_data();
 			$form->apply_changes();
-			$this->clear_caches( $form );
-			do_action( 'getpaid_create_payment_form', $form );
+			$this->clear_caches($form);
+			do_action('getpaid_create_payment_form', $form);
 			return true;
 		}
 
-		if ( is_wp_error( $id ) ) {
+		if (is_wp_error($id)) {
 			$form->last_error = $id->get_error_message();
 		}
 
@@ -99,14 +99,14 @@ 
 	 * @param GetPaid_Payment_Form $form Form object.
 	 *
 	 */
-	public function read( &$form ) {
+	public function read(&$form) {
 
 		$form->set_defaults();
-		$form_object = get_post( $form->get_id() );
+		$form_object = get_post($form->get_id());
 
-		if ( ! $form->get_id() || ! $form_object || $form_object->post_type != 'wpi_payment_form' ) {
-			$form->last_error = __( 'Invalid form.', 'invoicing' );
-			$form->set_id( 0 );
+		if (!$form->get_id() || !$form_object || $form_object->post_type != 'wpi_payment_form') {
+			$form->last_error = __('Invalid form.', 'invoicing');
+			$form->set_id(0);
 			return false;
 		}
 
@@ -120,10 +120,10 @@ 
 			)
 		);
 
-		$this->read_object_data( $form, $form_object );
+		$this->read_object_data($form, $form_object);
 		$form->read_meta_data();
-		$form->set_object_read( true );
-		do_action( 'getpaid_read_payment_form', $form );
+		$form->set_object_read(true);
+		do_action('getpaid_read_payment_form', $form);
 
 	}
 
@@ -132,27 +132,27 @@ 
 	 *
 	 * @param GetPaid_Payment_Form $form Form object.
 	 */
-	public function update( &$form ) {
+	public function update(&$form) {
 		$form->save_meta_data();
-		$form->set_version( WPINV_VERSION );
+		$form->set_version(WPINV_VERSION);
 
-		if ( null === $form->get_date_created( 'edit' ) ) {
-			$form->set_date_created(  current_time('mysql') );
+		if (null === $form->get_date_created('edit')) {
+			$form->set_date_created(current_time('mysql'));
 		}
 
 		// Grab the current status so we can compare.
-		$previous_status = get_post_status( $form->get_id() );
+		$previous_status = get_post_status($form->get_id());
 
 		$changes = $form->get_changes();
 
 		// Only update the post when the post data changes.
-		if ( array_intersect( array( 'date_created', 'date_modified', 'status', 'name', 'author' ), array_keys( $changes ) ) ) {
+		if (array_intersect(array('date_created', 'date_modified', 'status', 'name', 'author'), array_keys($changes))) {
 			$post_data = array(
-				'post_date'         => $form->get_date_created( 'edit' ),
-				'post_status'       => $form->get_status( 'edit' ),
-				'post_title'        => $form->get_name( 'edit' ),
-				'post_author'       => $form->get_author( 'edit' ),
-				'post_modified'     => $form->get_date_modified( 'edit' ),
+				'post_date'         => $form->get_date_created('edit'),
+				'post_status'       => $form->get_status('edit'),
+				'post_title'        => $form->get_name('edit'),
+				'post_author'       => $form->get_author('edit'),
+				'post_modified'     => $form->get_date_modified('edit'),
 			);
 
 			/**
@@ -163,25 +163,25 @@ 
 			 * This ensures hooks are fired by either WP itself (admin screen save),
 			 * or an update purely from CRUD.
 			 */
-			if ( doing_action( 'save_post' ) ) {
-				$GLOBALS['wpdb']->update( $GLOBALS['wpdb']->posts, $post_data, array( 'ID' => $form->get_id() ) );
-				clean_post_cache( $form->get_id() );
+			if (doing_action('save_post')) {
+				$GLOBALS['wpdb']->update($GLOBALS['wpdb']->posts, $post_data, array('ID' => $form->get_id()));
+				clean_post_cache($form->get_id());
 			} else {
-				wp_update_post( array_merge( array( 'ID' => $form->get_id() ), $post_data ) );
+				wp_update_post(array_merge(array('ID' => $form->get_id()), $post_data));
 			}
-			$form->read_meta_data( true ); // Refresh internal meta data, in case things were hooked into `save_post` or another WP hook.
+			$form->read_meta_data(true); // Refresh internal meta data, in case things were hooked into `save_post` or another WP hook.
 		}
-		$this->update_post_meta( $form );
+		$this->update_post_meta($form);
 		$form->apply_changes();
-		$this->clear_caches( $form );
+		$this->clear_caches($form);
 
 		// Fire a hook depending on the status - this should be considered a creation if it was previously draft status.
-		$new_status = $form->get_status( 'edit' );
+		$new_status = $form->get_status('edit');
 
-		if ( $new_status !== $previous_status && in_array( $previous_status, array( 'new', 'auto-draft', 'draft' ), true ) ) {
-			do_action( 'getpaid_new_payment_form', $form );
+		if ($new_status !== $previous_status && in_array($previous_status, array('new', 'auto-draft', 'draft'), true)) {
+			do_action('getpaid_new_payment_form', $form);
 		} else {
-			do_action( 'getpaid_update_payment_form', $form );
+			do_action('getpaid_update_payment_form', $form);
 		}
 
 	}

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

Indentation +186 added lines, -186 removed lines

@@ -5,7 +5,7 @@ 
  *
  */
 if ( ! defined( 'ABSPATH' ) ) {
-	exit;
+    exit;
 }
 
 /**
@@ -15,196 +15,196 @@ 
  */
 class GetPaid_Discount_Data_Store extends GetPaid_Data_Store_WP {
 
-	/**
-	 * Data stored in meta keys, but not considered "meta" for a discount.
-	 *
-	 * @since 1.0.19
-	 * @var array
-	 */
-	protected $internal_meta_keys = array(
-		'_wpi_discount_code',
-		'_wpi_discount_amount',
-		'_wpi_discount_start',
-		'_wpi_discount_expiration',
-		'_wpi_discount_type',
-		'_wpi_discount_uses',
-		'_wpi_discount_is_single_use',
-		'_wpi_discount_items',
-		'_wpi_discount_excluded_items',
-		'_wpi_discount_max_uses',
-		'_wpi_discount_is_recurring',
-		'_wpi_discount_min_total',
-		'_wpi_discount_max_total',
-	);
-
-	/**
-	 * A map of meta keys to data props.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @var array
-	 */
-	protected $meta_key_to_props = array(
-		'_wpi_discount_code'           => 'code',
-		'_wpi_discount_amount'         => 'amount',
-		'_wpi_discount_start'          => 'start',
-		'_wpi_discount_expiration'     => 'expiration',
-		'_wpi_discount_type'           => 'type',
-		'_wpi_discount_uses'           => 'uses',
-		'_wpi_discount_is_single_use'  => 'is_single_use',
-		'_wpi_discount_items'          => 'items',
-		'_wpi_discount_excluded_items' => 'excluded_items',
-		'_wpi_discount_max_uses'       => 'max_uses',
-		'_wpi_discount_is_recurring'   => 'is_recurring',
-		'_wpi_discount_min_total'      => 'min_total',
-		'_wpi_discount_max_total'      => 'max_total',
-	);
-
-	/*
+    /**
+     * Data stored in meta keys, but not considered "meta" for a discount.
+     *
+     * @since 1.0.19
+     * @var array
+     */
+    protected $internal_meta_keys = array(
+        '_wpi_discount_code',
+        '_wpi_discount_amount',
+        '_wpi_discount_start',
+        '_wpi_discount_expiration',
+        '_wpi_discount_type',
+        '_wpi_discount_uses',
+        '_wpi_discount_is_single_use',
+        '_wpi_discount_items',
+        '_wpi_discount_excluded_items',
+        '_wpi_discount_max_uses',
+        '_wpi_discount_is_recurring',
+        '_wpi_discount_min_total',
+        '_wpi_discount_max_total',
+    );
+
+    /**
+     * A map of meta keys to data props.
+     *
+     * @since 1.0.19
+     *
+     * @var array
+     */
+    protected $meta_key_to_props = array(
+        '_wpi_discount_code'           => 'code',
+        '_wpi_discount_amount'         => 'amount',
+        '_wpi_discount_start'          => 'start',
+        '_wpi_discount_expiration'     => 'expiration',
+        '_wpi_discount_type'           => 'type',
+        '_wpi_discount_uses'           => 'uses',
+        '_wpi_discount_is_single_use'  => 'is_single_use',
+        '_wpi_discount_items'          => 'items',
+        '_wpi_discount_excluded_items' => 'excluded_items',
+        '_wpi_discount_max_uses'       => 'max_uses',
+        '_wpi_discount_is_recurring'   => 'is_recurring',
+        '_wpi_discount_min_total'      => 'min_total',
+        '_wpi_discount_max_total'      => 'max_total',
+    );
+
+    /*
 	|--------------------------------------------------------------------------
 	| CRUD Methods
 	|--------------------------------------------------------------------------
 	*/
 
-	/**
-	 * Method to create a new discount in the database.
-	 *
-	 * @param WPInv_Discount $discount Discount object.
-	 */
-	public function create( &$discount ) {
-		$discount->set_version( WPINV_VERSION );
-		$discount->set_date_created( current_time('mysql') );
-
-		// Create a new post.
-		$id = wp_insert_post(
-			apply_filters(
-				'getpaid_new_discount_data',
-				array(
-					'post_date'     => $discount->get_date_created( 'edit' ),
-					'post_type'     => 'wpi_discount',
-					'post_status'   => $this->get_post_status( $discount ),
-					'ping_status'   => 'closed',
-					'post_author'   => $discount->get_author( 'edit' ),
-					'post_title'    => $discount->get_name( 'edit' ),
-					'post_excerpt'  => $discount->get_description( 'edit' ),
-				)
-			),
-			true
-		);
-
-		if ( $id && ! is_wp_error( $id ) ) {
-			$discount->set_id( $id );
-			$this->update_post_meta( $discount );
-			$discount->save_meta_data();
-			$discount->apply_changes();
-			$this->clear_caches( $discount );
-			do_action( 'getpaid_new_discount', $discount );
-			return true;
-		}
-
-		if ( is_wp_error( $id ) ) {
-			$discount->last_error = $id->get_error_message();
-		}
-
-		return false;
-	}
-
-	/**
-	 * Method to read a discount from the database.
-	 *
-	 * @param WPInv_Discount $discount Discount object.
-	 *
-	 */
-	public function read( &$discount ) {
-
-		$discount->set_defaults();
-		$discount_object = get_post( $discount->get_id() );
-
-		if ( ! $discount->get_id() || ! $discount_object || $discount_object->post_type != 'wpi_discount' ) {
-			$discount->last_error = __( 'Invalid discount.', 'invoicing' );
-			$discount->set_id( 0 );
-			return false;
-		}
-
-		$discount->set_props(
-			array(
-				'date_created'  => 0 < $discount_object->post_date ? $discount_object->post_date : null,
-				'date_modified' => 0 < $discount_object->post_modified ? $discount_object->post_modified : null,
-				'status'        => $discount_object->post_status,
-				'name'          => $discount_object->post_title,
-				'author'        => $discount_object->post_author,
-				'description'   => $discount_object->post_excerpt,
-			)
-		);
-
-		$this->read_object_data( $discount, $discount_object );
-		$discount->read_meta_data();
-		$discount->set_object_read( true );
-		do_action( 'getpaid_read_discount', $discount );
-
-	}
-
-	/**
-	 * Method to update a discount in the database.
-	 *
-	 * @param WPInv_Discount $discount Discount object.
-	 */
-	public function update( &$discount ) {
-		$discount->save_meta_data();
-		$discount->set_version( WPINV_VERSION );
-
-		if ( null === $discount->get_date_created( 'edit' ) ) {
-			$discount->set_date_created(  current_time('mysql') );
-		}
-
-		// Grab the current status so we can compare.
-		$previous_status = get_post_status( $discount->get_id() );
-
-		$changes = $discount->get_changes();
-
-		// Only update the post when the post data changes.
-		if ( array_intersect( array( 'date_created', 'date_modified', 'status', 'name', 'author', 'post_excerpt' ), array_keys( $changes ) ) ) {
-			$post_data = array(
-				'post_date'         => $discount->get_date_created( 'edit' ),
-				'post_status'       => $discount->get_status( 'edit' ),
-				'post_title'        => $discount->get_name( 'edit' ),
-				'post_author'       => $discount->get_author( 'edit' ),
-				'post_modified'     => $discount->get_date_modified( 'edit' ),
-				'post_excerpt'      => $discount->get_description( 'edit' ),
-			);
-
-			/**
-			 * When updating this object, to prevent infinite loops, use $wpdb
-			 * to update data, since wp_update_post spawns more calls to the
-			 * save_post action.
-			 *
-			 * This ensures hooks are fired by either WP itself (admin screen save),
-			 * or an update purely from CRUD.
-			 */
-			if ( doing_action( 'save_post' ) ) {
-				$GLOBALS['wpdb']->update( $GLOBALS['wpdb']->posts, $post_data, array( 'ID' => $discount->get_id() ) );
-				clean_post_cache( $discount->get_id() );
-			} else {
-				wp_update_post( array_merge( array( 'ID' => $discount->get_id() ), $post_data ) );
-			}
-			$discount->read_meta_data( true ); // Refresh internal meta data, in case things were hooked into `save_post` or another WP hook.
-		}
-		$this->update_post_meta( $discount );
-		$discount->apply_changes();
-		$this->clear_caches( $discount );
-
-		// Fire a hook depending on the status - this should be considered a creation if it was previously draft status.
-		$new_status = $discount->get_status( 'edit' );
-
-		if ( $new_status !== $previous_status && in_array( $previous_status, array( 'new', 'auto-draft', 'draft' ), true ) ) {
-			do_action( 'getpaid_new_discount', $discount );
-		} else {
-			do_action( 'getpaid_update_discount', $discount );
-		}
-
-	}
-
-	/*
+    /**
+     * Method to create a new discount in the database.
+     *
+     * @param WPInv_Discount $discount Discount object.
+     */
+    public function create( &$discount ) {
+        $discount->set_version( WPINV_VERSION );
+        $discount->set_date_created( current_time('mysql') );
+
+        // Create a new post.
+        $id = wp_insert_post(
+            apply_filters(
+                'getpaid_new_discount_data',
+                array(
+                    'post_date'     => $discount->get_date_created( 'edit' ),
+                    'post_type'     => 'wpi_discount',
+                    'post_status'   => $this->get_post_status( $discount ),
+                    'ping_status'   => 'closed',
+                    'post_author'   => $discount->get_author( 'edit' ),
+                    'post_title'    => $discount->get_name( 'edit' ),
+                    'post_excerpt'  => $discount->get_description( 'edit' ),
+                )
+            ),
+            true
+        );
+
+        if ( $id && ! is_wp_error( $id ) ) {
+            $discount->set_id( $id );
+            $this->update_post_meta( $discount );
+            $discount->save_meta_data();
+            $discount->apply_changes();
+            $this->clear_caches( $discount );
+            do_action( 'getpaid_new_discount', $discount );
+            return true;
+        }
+
+        if ( is_wp_error( $id ) ) {
+            $discount->last_error = $id->get_error_message();
+        }
+
+        return false;
+    }
+
+    /**
+     * Method to read a discount from the database.
+     *
+     * @param WPInv_Discount $discount Discount object.
+     *
+     */
+    public function read( &$discount ) {
+
+        $discount->set_defaults();
+        $discount_object = get_post( $discount->get_id() );
+
+        if ( ! $discount->get_id() || ! $discount_object || $discount_object->post_type != 'wpi_discount' ) {
+            $discount->last_error = __( 'Invalid discount.', 'invoicing' );
+            $discount->set_id( 0 );
+            return false;
+        }
+
+        $discount->set_props(
+            array(
+                'date_created'  => 0 < $discount_object->post_date ? $discount_object->post_date : null,
+                'date_modified' => 0 < $discount_object->post_modified ? $discount_object->post_modified : null,
+                'status'        => $discount_object->post_status,
+                'name'          => $discount_object->post_title,
+                'author'        => $discount_object->post_author,
+                'description'   => $discount_object->post_excerpt,
+            )
+        );
+
+        $this->read_object_data( $discount, $discount_object );
+        $discount->read_meta_data();
+        $discount->set_object_read( true );
+        do_action( 'getpaid_read_discount', $discount );
+
+    }
+
+    /**
+     * Method to update a discount in the database.
+     *
+     * @param WPInv_Discount $discount Discount object.
+     */
+    public function update( &$discount ) {
+        $discount->save_meta_data();
+        $discount->set_version( WPINV_VERSION );
+
+        if ( null === $discount->get_date_created( 'edit' ) ) {
+            $discount->set_date_created(  current_time('mysql') );
+        }
+
+        // Grab the current status so we can compare.
+        $previous_status = get_post_status( $discount->get_id() );
+
+        $changes = $discount->get_changes();
+
+        // Only update the post when the post data changes.
+        if ( array_intersect( array( 'date_created', 'date_modified', 'status', 'name', 'author', 'post_excerpt' ), array_keys( $changes ) ) ) {
+            $post_data = array(
+                'post_date'         => $discount->get_date_created( 'edit' ),
+                'post_status'       => $discount->get_status( 'edit' ),
+                'post_title'        => $discount->get_name( 'edit' ),
+                'post_author'       => $discount->get_author( 'edit' ),
+                'post_modified'     => $discount->get_date_modified( 'edit' ),
+                'post_excerpt'      => $discount->get_description( 'edit' ),
+            );
+
+            /**
+             * When updating this object, to prevent infinite loops, use $wpdb
+             * to update data, since wp_update_post spawns more calls to the
+             * save_post action.
+             *
+             * This ensures hooks are fired by either WP itself (admin screen save),
+             * or an update purely from CRUD.
+             */
+            if ( doing_action( 'save_post' ) ) {
+                $GLOBALS['wpdb']->update( $GLOBALS['wpdb']->posts, $post_data, array( 'ID' => $discount->get_id() ) );
+                clean_post_cache( $discount->get_id() );
+            } else {
+                wp_update_post( array_merge( array( 'ID' => $discount->get_id() ), $post_data ) );
+            }
+            $discount->read_meta_data( true ); // Refresh internal meta data, in case things were hooked into `save_post` or another WP hook.
+        }
+        $this->update_post_meta( $discount );
+        $discount->apply_changes();
+        $this->clear_caches( $discount );
+
+        // Fire a hook depending on the status - this should be considered a creation if it was previously draft status.
+        $new_status = $discount->get_status( 'edit' );
+
+        if ( $new_status !== $previous_status && in_array( $previous_status, array( 'new', 'auto-draft', 'draft' ), true ) ) {
+            do_action( 'getpaid_new_discount', $discount );
+        } else {
+            do_action( 'getpaid_update_discount', $discount );
+        }
+
+    }
+
+    /*
 	|--------------------------------------------------------------------------
 	| Additional Methods
 	|--------------------------------------------------------------------------

Spacing +46 added lines, -46 removed lines

@@ -4,7 +4,7 @@ 
  * GetPaid_Discount_Data_Store class file.
  *
  */
-if ( ! defined( 'ABSPATH' ) ) {
+if (!defined('ABSPATH')) {
 	exit;
 }
 
@@ -71,38 +71,38 @@ 
 	 *
 	 * @param WPInv_Discount $discount Discount object.
 	 */
-	public function create( &$discount ) {
-		$discount->set_version( WPINV_VERSION );
-		$discount->set_date_created( current_time('mysql') );
+	public function create(&$discount) {
+		$discount->set_version(WPINV_VERSION);
+		$discount->set_date_created(current_time('mysql'));
 
 		// Create a new post.
 		$id = wp_insert_post(
 			apply_filters(
 				'getpaid_new_discount_data',
 				array(
-					'post_date'     => $discount->get_date_created( 'edit' ),
+					'post_date'     => $discount->get_date_created('edit'),
 					'post_type'     => 'wpi_discount',
-					'post_status'   => $this->get_post_status( $discount ),
+					'post_status'   => $this->get_post_status($discount),
 					'ping_status'   => 'closed',
-					'post_author'   => $discount->get_author( 'edit' ),
-					'post_title'    => $discount->get_name( 'edit' ),
-					'post_excerpt'  => $discount->get_description( 'edit' ),
+					'post_author'   => $discount->get_author('edit'),
+					'post_title'    => $discount->get_name('edit'),
+					'post_excerpt'  => $discount->get_description('edit'),
 				)
 			),
 			true
 		);
 
-		if ( $id && ! is_wp_error( $id ) ) {
-			$discount->set_id( $id );
-			$this->update_post_meta( $discount );
+		if ($id && !is_wp_error($id)) {
+			$discount->set_id($id);
+			$this->update_post_meta($discount);
 			$discount->save_meta_data();
 			$discount->apply_changes();
-			$this->clear_caches( $discount );
-			do_action( 'getpaid_new_discount', $discount );
+			$this->clear_caches($discount);
+			do_action('getpaid_new_discount', $discount);
 			return true;
 		}
 
-		if ( is_wp_error( $id ) ) {
+		if (is_wp_error($id)) {
 			$discount->last_error = $id->get_error_message();
 		}
 
@@ -115,14 +115,14 @@ 
 	 * @param WPInv_Discount $discount Discount object.
 	 *
 	 */
-	public function read( &$discount ) {
+	public function read(&$discount) {
 
 		$discount->set_defaults();
-		$discount_object = get_post( $discount->get_id() );
+		$discount_object = get_post($discount->get_id());
 
-		if ( ! $discount->get_id() || ! $discount_object || $discount_object->post_type != 'wpi_discount' ) {
-			$discount->last_error = __( 'Invalid discount.', 'invoicing' );
-			$discount->set_id( 0 );
+		if (!$discount->get_id() || !$discount_object || $discount_object->post_type != 'wpi_discount') {
+			$discount->last_error = __('Invalid discount.', 'invoicing');
+			$discount->set_id(0);
 			return false;
 		}
 
@@ -137,10 +137,10 @@ 
 			)
 		);
 
-		$this->read_object_data( $discount, $discount_object );
+		$this->read_object_data($discount, $discount_object);
 		$discount->read_meta_data();
-		$discount->set_object_read( true );
-		do_action( 'getpaid_read_discount', $discount );
+		$discount->set_object_read(true);
+		do_action('getpaid_read_discount', $discount);
 
 	}
 
@@ -149,28 +149,28 @@ 
 	 *
 	 * @param WPInv_Discount $discount Discount object.
 	 */
-	public function update( &$discount ) {
+	public function update(&$discount) {
 		$discount->save_meta_data();
-		$discount->set_version( WPINV_VERSION );
+		$discount->set_version(WPINV_VERSION);
 
-		if ( null === $discount->get_date_created( 'edit' ) ) {
-			$discount->set_date_created(  current_time('mysql') );
+		if (null === $discount->get_date_created('edit')) {
+			$discount->set_date_created(current_time('mysql'));
 		}
 
 		// Grab the current status so we can compare.
-		$previous_status = get_post_status( $discount->get_id() );
+		$previous_status = get_post_status($discount->get_id());
 
 		$changes = $discount->get_changes();
 
 		// Only update the post when the post data changes.
-		if ( array_intersect( array( 'date_created', 'date_modified', 'status', 'name', 'author', 'post_excerpt' ), array_keys( $changes ) ) ) {
+		if (array_intersect(array('date_created', 'date_modified', 'status', 'name', 'author', 'post_excerpt'), array_keys($changes))) {
 			$post_data = array(
-				'post_date'         => $discount->get_date_created( 'edit' ),
-				'post_status'       => $discount->get_status( 'edit' ),
-				'post_title'        => $discount->get_name( 'edit' ),
-				'post_author'       => $discount->get_author( 'edit' ),
-				'post_modified'     => $discount->get_date_modified( 'edit' ),
-				'post_excerpt'      => $discount->get_description( 'edit' ),
+				'post_date'         => $discount->get_date_created('edit'),
+				'post_status'       => $discount->get_status('edit'),
+				'post_title'        => $discount->get_name('edit'),
+				'post_author'       => $discount->get_author('edit'),
+				'post_modified'     => $discount->get_date_modified('edit'),
+				'post_excerpt'      => $discount->get_description('edit'),
 			);
 
 			/**
@@ -181,25 +181,25 @@ 
 			 * This ensures hooks are fired by either WP itself (admin screen save),
 			 * or an update purely from CRUD.
 			 */
-			if ( doing_action( 'save_post' ) ) {
-				$GLOBALS['wpdb']->update( $GLOBALS['wpdb']->posts, $post_data, array( 'ID' => $discount->get_id() ) );
-				clean_post_cache( $discount->get_id() );
+			if (doing_action('save_post')) {
+				$GLOBALS['wpdb']->update($GLOBALS['wpdb']->posts, $post_data, array('ID' => $discount->get_id()));
+				clean_post_cache($discount->get_id());
 			} else {
-				wp_update_post( array_merge( array( 'ID' => $discount->get_id() ), $post_data ) );
+				wp_update_post(array_merge(array('ID' => $discount->get_id()), $post_data));
 			}
-			$discount->read_meta_data( true ); // Refresh internal meta data, in case things were hooked into `save_post` or another WP hook.
+			$discount->read_meta_data(true); // Refresh internal meta data, in case things were hooked into `save_post` or another WP hook.
 		}
-		$this->update_post_meta( $discount );
+		$this->update_post_meta($discount);
 		$discount->apply_changes();
-		$this->clear_caches( $discount );
+		$this->clear_caches($discount);
 
 		// Fire a hook depending on the status - this should be considered a creation if it was previously draft status.
-		$new_status = $discount->get_status( 'edit' );
+		$new_status = $discount->get_status('edit');
 
-		if ( $new_status !== $previous_status && in_array( $previous_status, array( 'new', 'auto-draft', 'draft' ), true ) ) {
-			do_action( 'getpaid_new_discount', $discount );
+		if ($new_status !== $previous_status && in_array($previous_status, array('new', 'auto-draft', 'draft'), true)) {
+			do_action('getpaid_new_discount', $discount);
 		} else {
-			do_action( 'getpaid_update_discount', $discount );
+			do_action('getpaid_update_discount', $discount);
 		}
 
 	}

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

Indentation +338 added lines, -338 removed lines

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

Spacing +58 added lines, -58 removed lines

@@ -5,7 +5,7 @@ 
  * @version 1.0.19
  */
 
-defined( 'ABSPATH' ) || exit;
+defined('ABSPATH') || exit;
 
 /**
  * GetPaid_Data_Store_WP class.
@@ -64,7 +64,7 @@ 
 	 * @param  GetPaid_Data $object GetPaid_Data object.
 	 * @return array
 	 */
-	public function read_meta( &$object ) {
+	public function read_meta(&$object) {
 		global $wpdb;
 		$db_info       = $this->get_db_info();
 		$raw_meta_data = $wpdb->get_results(
@@ -77,9 +77,9 @@ 
 			)
 		);
 
-		$this->internal_meta_keys = array_merge( array_map( array( $this, 'prefix_key' ), $object->get_data_keys() ), $this->internal_meta_keys );
-		$meta_data                = array_filter( $raw_meta_data, array( $this, 'exclude_internal_meta_keys' ) );
-		return apply_filters( "getpaid_data_store_wp_{$this->meta_type}_read_meta", $meta_data, $object, $this );
+		$this->internal_meta_keys = array_merge(array_map(array($this, 'prefix_key'), $object->get_data_keys()), $this->internal_meta_keys);
+		$meta_data                = array_filter($raw_meta_data, array($this, 'exclude_internal_meta_keys'));
+		return apply_filters("getpaid_data_store_wp_{$this->meta_type}_read_meta", $meta_data, $object, $this);
 	}
 
 	/**
@@ -89,8 +89,8 @@ 
 	 * @param  GetPaid_Data  $object GetPaid_Data object.
 	 * @param  stdClass $meta (containing at least ->id).
 	 */
-	public function delete_meta( &$object, $meta ) {
-		delete_metadata_by_mid( $this->meta_type, $meta->id );
+	public function delete_meta(&$object, $meta) {
+		delete_metadata_by_mid($this->meta_type, $meta->id);
 	}
 
 	/**
@@ -101,8 +101,8 @@ 
 	 * @param  stdClass $meta (containing ->key and ->value).
 	 * @return int meta ID
 	 */
-	public function add_meta( &$object, $meta ) {
-		return add_metadata( $this->meta_type, $object->get_id(), $meta->key, is_string( $meta->value ) ? wp_slash( $meta->value ) : $meta->value, false );
+	public function add_meta(&$object, $meta) {
+		return add_metadata($this->meta_type, $object->get_id(), $meta->key, is_string($meta->value) ? wp_slash($meta->value) : $meta->value, false);
 	}
 
 	/**
@@ -112,8 +112,8 @@ 
 	 * @param  GetPaid_Data  $object GetPaid_Data object.
 	 * @param  stdClass $meta (containing ->id, ->key and ->value).
 	 */
-	public function update_meta( &$object, $meta ) {
-		update_metadata_by_mid( $this->meta_type, $meta->id, $meta->value, $meta->key );
+	public function update_meta(&$object, $meta) {
+		update_metadata_by_mid($this->meta_type, $meta->id, $meta->value, $meta->key);
 	}
 
 	/**
@@ -129,7 +129,7 @@ 
 		$table         = $wpdb->prefix;
 
 		// If we are dealing with a type of metadata that is not a core type, the table should be prefixed.
-		if ( ! in_array( $this->meta_type, array( 'post', 'user', 'comment', 'term' ), true ) ) {
+		if (!in_array($this->meta_type, array('post', 'user', 'comment', 'term'), true)) {
 			$table .= 'getpaid_';
 		}
 
@@ -137,12 +137,12 @@ 
 		$object_id_field = $this->meta_type . '_id';
 
 		// Figure out our field names.
-		if ( 'user' === $this->meta_type ) {
+		if ('user' === $this->meta_type) {
 			$meta_id_field = 'umeta_id';
 			$table         = $wpdb->usermeta;
 		}
 
-		if ( ! empty( $this->object_id_field_for_meta ) ) {
+		if (!empty($this->object_id_field_for_meta)) {
 			$object_id_field = $this->object_id_field_for_meta;
 		}
 
@@ -162,8 +162,8 @@ 
 	 * @param string $key Prefix to be added to meta keys.
 	 * @return string
 	 */
-	protected function prefix_key( $key ) {
-		return '_' === substr( $key, 0, 1 ) ? $key : '_' . $key;
+	protected function prefix_key($key) {
+		return '_' === substr($key, 0, 1) ? $key : '_' . $key;
 	}
 
 	/**
@@ -172,8 +172,8 @@ 
 	 * @param object $meta Meta object to check if it should be excluded or not.
 	 * @return bool
 	 */
-	protected function exclude_internal_meta_keys( $meta ) {
-		return ! in_array( $meta->meta_key, $this->internal_meta_keys, true ) && 0 !== stripos( $meta->meta_key, 'wp_' );
+	protected function exclude_internal_meta_keys($meta) {
+		return !in_array($meta->meta_key, $this->internal_meta_keys, true) && 0 !== stripos($meta->meta_key, 'wp_');
 	}
 
 	/**
@@ -185,14 +185,14 @@ 
 	 * @param  string  $meta_type           The internal WP meta type (post, user, etc).
 	 * @return array                        A mapping of meta keys => prop names, filtered by ones that should be updated.
 	 */
-	protected function get_props_to_update( $object, $meta_key_to_props, $meta_type = 'post' ) {
+	protected function get_props_to_update($object, $meta_key_to_props, $meta_type = 'post') {
 		$props_to_update = array();
 		$changed_props   = $object->get_changes();
 
 		// Props should be updated if they are a part of the $changed array or don't exist yet.
-		foreach ( $meta_key_to_props as $meta_key => $prop ) {
-			if ( array_key_exists( $prop, $changed_props ) || ! metadata_exists( $meta_type, $object->get_id(), $meta_key ) ) {
-				$props_to_update[ $meta_key ] = $prop;
+		foreach ($meta_key_to_props as $meta_key => $prop) {
+			if (array_key_exists($prop, $changed_props) || !metadata_exists($meta_type, $object->get_id(), $meta_key)) {
+				$props_to_update[$meta_key] = $prop;
 			}
 		}
 
@@ -206,22 +206,22 @@ 
 	 * @param WP_Post   $post_object Post object.
 	 * @since 1.0.19
 	 */
-	protected function read_object_data( &$object, $post_object ) {
+	protected function read_object_data(&$object, $post_object) {
 		$id    = $object->get_id();
 		$props = array();
 
-		foreach ( $this->meta_key_to_props as $meta_key => $prop ) {
-			$props[ $prop ] = get_post_meta( $id, $meta_key, true );
+		foreach ($this->meta_key_to_props as $meta_key => $prop) {
+			$props[$prop] = get_post_meta($id, $meta_key, true);
 		}
 
 		// Set object properties.
-		$object->set_props( $props );
+		$object->set_props($props);
 
 		// Gets extra data associated with the object if needed.
-		foreach ( $object->get_extra_data_keys() as $key ) {
+		foreach ($object->get_extra_data_keys() as $key) {
 			$function = 'set_' . $key;
-			if ( is_callable( array( $object, $function ) ) ) {
-				$object->{$function}( get_post_meta( $object->get_id(), $key, true ) );
+			if (is_callable(array($object, $function))) {
+				$object->{$function}(get_post_meta($object->get_id(), $key, true));
 			}
 		}
 	}
@@ -232,24 +232,24 @@ 
 	 * @param GetPaid_Data $object GetPaid_Data object.
 	 * @since 1.0.19
 	 */
-	protected function update_post_meta( &$object ) {
+	protected function update_post_meta(&$object) {
 
 		$updated_props   = array();
-		$props_to_update = $this->get_props_to_update( $object, $this->meta_key_to_props );
+		$props_to_update = $this->get_props_to_update($object, $this->meta_key_to_props);
 		$object_type     = $object->get_object_type();
 
-		foreach ( $props_to_update as $meta_key => $prop ) {
-			$value = $object->{"get_$prop"}( 'edit' );
-			$value = is_string( $value ) ? wp_slash( $value ) : $value;
+		foreach ($props_to_update as $meta_key => $prop) {
+			$value = $object->{"get_$prop"}('edit');
+			$value = is_string($value) ? wp_slash($value) : $value;
 
-			$updated = $this->update_or_delete_post_meta( $object, $meta_key, $value );
+			$updated = $this->update_or_delete_post_meta($object, $meta_key, $value);
 
-			if ( $updated ) {
+			if ($updated) {
 				$updated_props[] = $prop;
 			}
 		}
 
-		do_action( "getpaid_{$object_type}_object_updated_props", $object, $updated_props );
+		do_action("getpaid_{$object_type}_object_updated_props", $object, $updated_props);
 	}
 
 	/**
@@ -269,11 +269,11 @@ 
 	 *
 	 * @return bool True if updated/deleted.
 	 */
-	protected function update_or_delete_post_meta( $object, $meta_key, $meta_value ) {
-		if ( in_array( $meta_value, array( array(), '', null ), true ) && ! in_array( $meta_key, $this->must_exist_meta_keys, true ) ) {
-			$updated = delete_post_meta( $object->get_id(), $meta_key );
+	protected function update_or_delete_post_meta($object, $meta_key, $meta_value) {
+		if (in_array($meta_value, array(array(), '', null), true) && !in_array($meta_key, $this->must_exist_meta_keys, true)) {
+			$updated = delete_post_meta($object->get_id(), $meta_key);
 		} else {
-			$updated = update_post_meta( $object->get_id(), $meta_key, $meta_value );
+			$updated = update_post_meta($object->get_id(), $meta_key, $meta_value);
 		}
 
 		return (bool) $updated;
@@ -295,8 +295,8 @@ 
 	 * @param GetPaid_Data $object GetPaid_Data object.
 	 * @since 1.0.19
 	 */
-	protected function clear_caches( &$object ) {
-		clean_post_cache( $object->get_id() );
+	protected function clear_caches(&$object) {
+		clean_post_cache($object->get_id());
 	}
 
 	/**
@@ -307,33 +307,33 @@ 
 	 *
 	 * @return void
 	 */
-	public function delete( &$object, $args = array() ) {
+	public function delete(&$object, $args = array()) {
 		$id          = $object->get_id();
 		$object_type = $object->get_object_type();
 
-		if ( 'invoice' == $object_type ) {
+		if ('invoice' == $object_type) {
 			$object_type = $object->get_type();
 		}
 
-		$args        = wp_parse_args(
+		$args = wp_parse_args(
 			$args,
 			array(
 				'force_delete' => false,
 			)
 		);
 
-		if ( ! $id ) {
+		if (!$id) {
 			return;
 		}
 
-		if ( $args['force_delete'] ) {
-			do_action( "getpaid_delete_$object_type", $object );
-			wp_delete_post( $id, true );
-			$object->set_id( 0 );
+		if ($args['force_delete']) {
+			do_action("getpaid_delete_$object_type", $object);
+			wp_delete_post($id, true);
+			$object->set_id(0);
 		} else {
-			do_action( "getpaid_trash_$object_type", $object );
-			wp_trash_post( $id );
-			$object->set_status( 'trash' );
+			do_action("getpaid_trash_$object_type", $object);
+			wp_trash_post($id);
+			$object->set_status('trash');
 		}
 	}
 
@@ -345,12 +345,12 @@ 
 	 * @param  GetPaid_Data $object GetPaid_Data object.
 	 * @return string
 	 */
-	protected function get_post_status( $object ) {
-		$object_status = $object->get_status( 'edit' );
+	protected function get_post_status($object) {
+		$object_status = $object->get_status('edit');
 		$object_type   = $object->get_object_type();
 
-		if ( ! $object_status ) {
-			$object_status = apply_filters( "getpaid_default_{$object_type}_status", 'draft' );
+		if (!$object_status) {
+			$object_status = apply_filters("getpaid_default_{$object_type}_status", 'draft');
 		}
 
 		return $object_status;

includes/class-wpinv-notes.php

Indentation +114 added lines, -114 removed lines

@@ -12,119 +12,119 @@
  */
 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 );
-
-		// 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' ";
-	}
-
-	/**
-	 * 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;
-	}
+    /**
+     * 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 );
+
+        // 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' ";
+    }
+
+    /**
+     * 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;
+    }
 
 }

Spacing +23 added lines, -23 removed lines

@@ -4,7 +4,7 @@ 
  *
  */
 
-defined( 'ABSPATH' ) || exit;
+defined('ABSPATH') || exit;
 
 /**
  * Handles invoice notes.
@@ -18,11 +18,11 @@ 
 	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 );
+		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);
 
 		// Fires after notes are loaded.
-		do_action( 'wpinv_notes_init', $this );
+		do_action('wpinv_notes_init', $this);
 	}
 
 	/**
@@ -30,19 +30,19 @@ 
 	 *
 	 * @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'];
+	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 ) ) ) {
+		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'] ) ) {
+			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'] );
+			$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;
@@ -51,8 +51,8 @@ 
 	/**
 	 * Exclude notes from the comments feed.
 	 */
-	function wpinv_comment_feed_where( $where ){
-		return $where . ( $where ? ' AND ' : '' ) . " comment_type != 'wpinv_note' ";
+	function wpinv_comment_feed_where($where) {
+		return $where . ($where ? ' AND ' : '') . " comment_type != 'wpinv_note' ";
 	}
 
 	/**
@@ -62,7 +62,7 @@ 
 	 * @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' ) {
+	public function get_invoice_notes($invoice_id = 0, $type = 'all') {
 
 		// Default comment args.
 		$args = array(
@@ -72,14 +72,14 @@ 
 		);
 
 		// Maybe only show customer comments.
-		if ( $type == 'customer' ) {
+		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 );
+		$args = apply_filters('wpinv_invoice_notes_args', $args, $this, $invoice_id, $type);
 
-		return get_comments( $args );
+		return get_comments($args);
 	}
 
 	/**
@@ -91,9 +91,9 @@ 
 	 * @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 ){
+	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 );
+		do_action('wpinv_pre_insert_invoice_note', $invoice->get_id(), $note, $for_customer);
 
 		/**
 		 * Insert the comment.
@@ -114,16 +114,16 @@ 
 			)
 		);
 
-		do_action( 'wpinv_insert_payment_note', $note_id, $invoice->get_id(), $note, $for_customer );
+		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 ) ) {
+		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 );
+		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;
 	}
 

templates/emails/wpinv-email-onhold_invoice.php

Spacing +6 added lines, -6 removed lines

@@ -7,22 +7,22 @@
  * @version 1.0.19
  */
 
-defined( 'ABSPATH' ) || exit;
+defined('ABSPATH') || exit;
 
 // Print the email header.
-do_action( 'wpinv_email_header', $email_heading, $invoice, $email_type, $sent_to_admin );
+do_action('wpinv_email_header', $email_heading, $invoice, $email_type, $sent_to_admin);
 
 // Generate the custom message body.
 echo $message_body;
 
 // Print invoice details.
-do_action( 'wpinv_email_invoice_details', $invoice, $email_type, $sent_to_admin );
+do_action('wpinv_email_invoice_details', $invoice, $email_type, $sent_to_admin);
 
 // Print invoice items.
-do_action( 'wpinv_email_invoice_items', $invoice, $email_type, $sent_to_admin );
+do_action('wpinv_email_invoice_items', $invoice, $email_type, $sent_to_admin);
 
 // Print the billing details.
-do_action( 'wpinv_email_billing_details', $invoice, $email_type, $sent_to_admin );
+do_action('wpinv_email_billing_details', $invoice, $email_type, $sent_to_admin);
 
 // Print the email footer.
-do_action( 'wpinv_email_footer', $invoice, $email_type, $sent_to_admin );
+do_action('wpinv_email_footer', $invoice, $email_type, $sent_to_admin);

templates/emails/wpinv-email-processing_invoice.php

Spacing +6 added lines, -6 removed lines

@@ -7,22 +7,22 @@
  * @version 1.0.19
  */
 
-defined( 'ABSPATH' ) || exit;
+defined('ABSPATH') || exit;
 
 // Print the email header.
-do_action( 'wpinv_email_header', $email_heading, $invoice, $email_type, $sent_to_admin );
+do_action('wpinv_email_header', $email_heading, $invoice, $email_type, $sent_to_admin);
 
 // Generate the custom message body.
 echo $message_body;
 
 // Print invoice details.
-do_action( 'wpinv_email_invoice_details', $invoice, $email_type, $sent_to_admin );
+do_action('wpinv_email_invoice_details', $invoice, $email_type, $sent_to_admin);
 
 // Print invoice items.
-do_action( 'wpinv_email_invoice_items', $invoice, $email_type, $sent_to_admin );
+do_action('wpinv_email_invoice_items', $invoice, $email_type, $sent_to_admin);
 
 // Print the billing details.
-do_action( 'wpinv_email_billing_details', $invoice, $email_type, $sent_to_admin );
+do_action('wpinv_email_billing_details', $invoice, $email_type, $sent_to_admin);
 
 // Print the email footer.
-do_action( 'wpinv_email_footer', $invoice, $email_type, $sent_to_admin );
+do_action('wpinv_email_footer', $invoice, $email_type, $sent_to_admin);

templates/emails/wpinv-email-new_invoice.php

Spacing +6 added lines, -6 removed lines

@@ -7,22 +7,22 @@
  * @version 1.0.19
  */
 
-defined( 'ABSPATH' ) || exit;
+defined('ABSPATH') || exit;
 
 // Print the email header.
-do_action( 'wpinv_email_header', $email_heading, $invoice, $email_type, $sent_to_admin );
+do_action('wpinv_email_header', $email_heading, $invoice, $email_type, $sent_to_admin);
 
 // Generate the custom message body.
 echo $message_body;
 
 // Print invoice details.
-do_action( 'wpinv_email_invoice_details', $invoice, $email_type, $sent_to_admin );
+do_action('wpinv_email_invoice_details', $invoice, $email_type, $sent_to_admin);
 
 // Print invoice items.
-do_action( 'wpinv_email_invoice_items', $invoice, $email_type, $sent_to_admin );
+do_action('wpinv_email_invoice_items', $invoice, $email_type, $sent_to_admin);
 
 // Print the billing details.
-do_action( 'wpinv_email_billing_details', $invoice, $email_type, $sent_to_admin );
+do_action('wpinv_email_billing_details', $invoice, $email_type, $sent_to_admin);
 
 // Print the email footer.
-do_action( 'wpinv_email_footer', $invoice, $email_type, $sent_to_admin );
+do_action('wpinv_email_footer', $invoice, $email_type, $sent_to_admin);

templates/emails/wpinv-email-completed_invoice.php

Spacing +6 added lines, -6 removed lines

@@ -7,22 +7,22 @@
  * @version 1.0.19
  */
 
-defined( 'ABSPATH' ) || exit;
+defined('ABSPATH') || exit;
 
 // Print the email header.
-do_action( 'wpinv_email_header', $email_heading, $invoice, $email_type, $sent_to_admin );
+do_action('wpinv_email_header', $email_heading, $invoice, $email_type, $sent_to_admin);
 
 // Generate the custom message body.
 echo $message_body;
 
 // Print invoice details.
-do_action( 'wpinv_email_invoice_details', $invoice, $email_type, $sent_to_admin );
+do_action('wpinv_email_invoice_details', $invoice, $email_type, $sent_to_admin);
 
 // Print invoice items.
-do_action( 'wpinv_email_invoice_items', $invoice, $email_type, $sent_to_admin );
+do_action('wpinv_email_invoice_items', $invoice, $email_type, $sent_to_admin);
 
 // Print the billing details.
-do_action( 'wpinv_email_billing_details', $invoice, $email_type, $sent_to_admin );
+do_action('wpinv_email_billing_details', $invoice, $email_type, $sent_to_admin);
 
 // Print the email footer.
-do_action( 'wpinv_email_footer', $invoice, $email_type, $sent_to_admin );
+do_action('wpinv_email_footer', $invoice, $email_type, $sent_to_admin);