AyeCode / invoicing

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

Braces +3 added lines, -1 removed lines

@@ -3,7 +3,9 @@
  * Displays a list of all subscriptions rules
  */
 
-if ( ! defined( 'ABSPATH' ) ) exit;
+if ( ! defined( 'ABSPATH' ) ) {
+    exit;
+}
 
 if ( ! class_exists( 'WP_List_Table' ) ) {
 	include_once ABSPATH . 'wp-admin/includes/class-wp-list-table.php';

Indentation +369 added lines, -369 removed lines

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

Spacing +74 added lines, -74 removed lines

@@ -3,9 +3,9 @@ 
  * Displays a list of all subscriptions rules
  */
 
-if ( ! defined( 'ABSPATH' ) ) exit;
+if (!defined('ABSPATH')) exit;
 
-if ( ! class_exists( 'WP_List_Table' ) ) {
+if (!class_exists('WP_List_Table')) {
 	include_once ABSPATH . 'wp-admin/includes/class-wp-list-table.php';
 }
 
@@ -78,7 +78,7 @@ 
 
 		$this->prepare_query();
 
-		$this->base_url = remove_query_arg( 'status' );
+		$this->base_url = remove_query_arg('status');
 
 	}
 
@@ -91,21 +91,21 @@ 
 		$query = array(
 			'number'  => $this->per_page,
 			'paged'   => $this->get_paged(),
-			'status'  => ( isset( $_GET['status'] ) && array_key_exists( $_GET['status'], getpaid_get_subscription_statuses() ) ) ? $_GET['status'] : 'all',
-			'orderby' => ( isset( $_GET['orderby'] ) ) ? $_GET['orderby'] : 'id',
-			'order'   => ( isset( $_GET['order'] ) ) ? $_GET['order'] : 'DESC',
+			'status'  => (isset($_GET['status']) && array_key_exists($_GET['status'], getpaid_get_subscription_statuses())) ? $_GET['status'] : 'all',
+			'orderby' => (isset($_GET['orderby'])) ? $_GET['orderby'] : 'id',
+			'order'   => (isset($_GET['order'])) ? $_GET['order'] : 'DESC',
 		);
 
 		// Prepare class properties.
-		$this->query               = new GetPaid_Subscriptions_Query( $query );
+		$this->query               = new GetPaid_Subscriptions_Query($query);
 		$this->total_count         = $this->query->get_total();
 		$this->current_total_count = $this->query->get_total();
 		$this->items               = $this->query->get_results();
-		$this->status_counts       = getpaid_get_subscription_status_counts( $query );
+		$this->status_counts       = getpaid_get_subscription_status_counts($query);
 
-		if ( 'all' != $query['status'] ) {
-			unset( $query['status'] );
-			$this->total_count   = getpaid_get_subscriptions( $query, 'count' );
+		if ('all' != $query['status']) {
+			unset($query['status']);
+			$this->total_count = getpaid_get_subscriptions($query, 'count');
 		}
 
 	}
@@ -122,26 +122,26 @@ 
 	 */
 	public function get_views() {
 
-		$current  = isset( $_GET['status'] ) ? $_GET['status'] : 'all';
+		$current  = isset($_GET['status']) ? $_GET['status'] : 'all';
 		$views    = array(
 
 			'all' => sprintf(
 				'<a href="%s" %s>%s&nbsp;<span class="count">(%d)</span></a>',
-				esc_url( add_query_arg( 'status', false, $this->base_url ) ),
+				esc_url(add_query_arg('status', false, $this->base_url)),
 				$current === 'all' ? ' class="current"' : '',
-				__('All','invoicing' ),
+				__('All', 'invoicing'),
 				$this->total_count
 			)
 
 		);
 
-		foreach ( array_filter( $this->status_counts ) as $status => $count ) {
+		foreach (array_filter($this->status_counts) as $status => $count) {
 
-			$views[ $status ] = sprintf(
+			$views[$status] = sprintf(
 				'<a href="%s" %s>%s&nbsp;<span class="count">(%d)</span></a>',
-				esc_url( add_query_arg( 'status', urlencode( $status ), $this->base_url ) ),
+				esc_url(add_query_arg('status', urlencode($status), $this->base_url)),
 				$current === $status ? ' class="current"' : '',
-				sanitize_text_field( getpaid_get_subscription_status_label( $status ) ),
+				sanitize_text_field(getpaid_get_subscription_status_label($status)),
 				$count
 			);
 
@@ -158,8 +158,8 @@ 
 	 * @since       1.0.0
 	 * @return      string
 	 */
-	public function column_default( $item, $column_name ) {
-		return apply_filters( "getpaid_subscriptions_table_column_$column_name", $item->$column_name );
+	public function column_default($item, $column_name) {
+		return apply_filters("getpaid_subscriptions_table_column_$column_name", $item->$column_name);
 	}
 
 	/**
@@ -168,8 +168,8 @@ 
 	 * @param WPInv_Subscription $item
 	 * @return string
 	 */
-	public function column_cb( $item ) {
-		return sprintf( '<input type="checkbox" name="id[]" value="%s" />', esc_html( $item->get_id() ) );
+	public function column_cb($item) {
+		return sprintf('<input type="checkbox" name="id[]" value="%s" />', esc_html($item->get_id()));
 	}
 
 	/**
@@ -179,7 +179,7 @@ 
 	 * @since       1.0.0
 	 * @return      string
 	 */
-	public function column_status( $item ) {
+	public function column_status($item) {
 		return $item->get_status_label_html();
 	}
 
@@ -190,46 +190,46 @@ 
 	 * @since       1.0.0
 	 * @return      string
 	 */
-	public function column_subscription( $item ) {
+	public function column_subscription($item) {
 
-		$username = __( '(Missing User)', 'invoicing' );
+		$username = __('(Missing User)', 'invoicing');
 
-		$user = get_userdata( $item->get_customer_id() );
-		if ( $user ) {
+		$user = get_userdata($item->get_customer_id());
+		if ($user) {
 
 			$username = sprintf(
 				'<a href="user-edit.php?user_id=%s">%s</a>',
-				absint( $user->ID ),
-				! empty( $user->display_name ) ? sanitize_text_field( $user->display_name ) : sanitize_email( $user->user_email )
+				absint($user->ID),
+				!empty($user->display_name) ? sanitize_text_field($user->display_name) : sanitize_email($user->user_email)
 			);
 
 		}
 
 		// translators: $1: is opening link, $2: is subscription id number, $3: is closing link tag, $4: is user's name
 		$column_content = sprintf(
-			_x( '%1$s#%2$s%3$s for %4$s', 'Subscription title on admin table. (e.g.: #211 for John Doe)', 'invoicing' ),
-			'<a href="' . esc_url( admin_url( 'admin.php?page=wpinv-subscriptions&id=' . absint( $item->get_id() ) ) ) . '">',
-			'<strong>' . esc_attr( $item->get_id() ) . '</strong>', '</a>',
+			_x('%1$s#%2$s%3$s for %4$s', 'Subscription title on admin table. (e.g.: #211 for John Doe)', 'invoicing'),
+			'<a href="' . esc_url(admin_url('admin.php?page=wpinv-subscriptions&id=' . absint($item->get_id()))) . '">',
+			'<strong>' . esc_attr($item->get_id()) . '</strong>', '</a>',
 			$username
 		);
 
 		$row_actions = array();
 
 		// View subscription.
-		$view_url    = esc_url( add_query_arg( 'id', $item->get_id(), admin_url( 'admin.php?page=wpinv-subscriptions' ) ));
-		$row_actions['view'] = '<a href="' . $view_url . '">' . __( 'View Subscription', 'invoicing' ) . '</a>';
+		$view_url    = esc_url(add_query_arg('id', $item->get_id(), admin_url('admin.php?page=wpinv-subscriptions')));
+		$row_actions['view'] = '<a href="' . $view_url . '">' . __('View Subscription', 'invoicing') . '</a>';
 
 		// View invoice.
-		$invoice = get_post( $item->get_parent_invoice_id() );
+		$invoice = get_post($item->get_parent_invoice_id());
 
-		if ( ! empty( $invoice ) ) {
-			$view_url    = get_edit_post_link( $invoice );
-			$row_actions['invoice'] = '<a href="' . $view_url . '">' . __( 'View Invoice', 'invoicing' ) . '</a>';
+		if (!empty($invoice)) {
+			$view_url = get_edit_post_link($invoice);
+			$row_actions['invoice'] = '<a href="' . $view_url . '">' . __('View Invoice', 'invoicing') . '</a>';
 		}
 
-		$row_actions = $this->row_actions( apply_filters( 'getpaid_subscription_table_row_actions', $row_actions, $item ) );
+		$row_actions = $this->row_actions(apply_filters('getpaid_subscription_table_row_actions', $row_actions, $item));
 
-		return "<strong>$column_content</strong>" . $this->column_amount( $item ) . $row_actions;
+		return "<strong>$column_content</strong>" . $this->column_amount($item) . $row_actions;
 	}
 
 	/**
@@ -239,8 +239,8 @@ 
 	 * @since       1.0.0
 	 * @return      string
 	 */
-	public function column_renewal_date( $item ) {
-		return getpaid_format_date_value( $item->get_expiration() );
+	public function column_renewal_date($item) {
+		return getpaid_format_date_value($item->get_expiration());
 	}
 
 	/**
@@ -250,8 +250,8 @@ 
 	 * @since       1.0.0
 	 * @return      string
 	 */
-	public function column_start_date( $item ) {
-		return getpaid_format_date_value( $item->get_date_created() );
+	public function column_start_date($item) {
+		return getpaid_format_date_value($item->get_date_created());
 	}
 
 	/**
@@ -261,8 +261,8 @@ 
 	 * @since       1.0.19
 	 * @return      string
 	 */
-	public function column_amount( $item ) {
-		$amount = getpaid_get_formatted_subscription_amount( $item );
+	public function column_amount($item) {
+		$amount = getpaid_get_formatted_subscription_amount($item);
 		return "<span class='text-muted form-text mt-2 mb-2'>$amount</span>";
 	}
 
@@ -273,9 +273,9 @@ 
 	 * @since       1.0.0
 	 * @return      string
 	 */
-	public function column_renewals( $item ) {
+	public function column_renewals($item) {
 		$max_bills = $item->get_bill_times();
-		return $item->get_times_billed() . ' / ' . ( empty( $max_bills ) ? "&infin;" : $max_bills );
+		return $item->get_times_billed() . ' / ' . (empty($max_bills) ? "&infin;" : $max_bills);
 	}
 
 	/**
@@ -285,16 +285,16 @@ 
 	 * @since       1.0.0
 	 * @return      string
 	 */
-	public function column_item( $item ) {
-		$_item = get_post( $item->get_product_id() );
+	public function column_item($item) {
+		$_item = get_post($item->get_product_id());
 
-		if ( ! empty( $_item ) ) {
-			$link = get_edit_post_link( $_item );
-			$link = esc_url( $link );
-			$name = esc_html( get_the_title( $_item ) );
+		if (!empty($_item)) {
+			$link = get_edit_post_link($_item);
+			$link = esc_url($link);
+			$name = esc_html(get_the_title($_item));
 			return "<a href='$link'>$name</a>";
 		} else {
-			return sprintf( __( 'Item #%s', 'invoicing' ), $item->get_product_id() );
+			return sprintf(__('Item #%s', 'invoicing'), $item->get_product_id());
 		}
 
 	}
@@ -305,7 +305,7 @@ 
 	 * @return      int
 	 */
 	public function get_paged() {
-		return isset( $_GET['paged'] ) ? absint( $_GET['paged'] ) : 1;
+		return isset($_GET['paged']) ? absint($_GET['paged']) : 1;
 	}
 
 	/**
@@ -318,13 +318,13 @@ 
 		$hidden   = array();
 		$sortable = $this->get_sortable_columns();
 
-		$this->_column_headers = array( $columns, $hidden, $sortable );
+		$this->_column_headers = array($columns, $hidden, $sortable);
 
 		$this->set_pagination_args(
 			array(
 			'total_items' => $this->current_total_count,
 			'per_page'    => $this->per_page,
-			'total_pages' => ceil( $this->current_total_count / $this->per_page )
+			'total_pages' => ceil($this->current_total_count / $this->per_page)
 			)
 		);
 	}
@@ -334,18 +334,18 @@ 
 	 *
 	 * @return array
 	 */
-	public function get_columns(){
+	public function get_columns() {
 		$columns = array(
 			'cb'                => '<input type="checkbox" />',
-			'subscription'      => __( 'Subscription', 'invoicing' ),
-			'start_date'        => __( 'Start Date', 'invoicing' ),
-			'renewal_date'      => __( 'Next Payment', 'invoicing' ),
-			'renewals'          => __( 'Renewals', 'invoicing' ),
-			'item'              => __( 'Item', 'invoicing' ),
-			'status'            => __( 'Status', 'invoicing' ),
+			'subscription'      => __('Subscription', 'invoicing'),
+			'start_date'        => __('Start Date', 'invoicing'),
+			'renewal_date'      => __('Next Payment', 'invoicing'),
+			'renewals'          => __('Renewals', 'invoicing'),
+			'item'              => __('Item', 'invoicing'),
+			'status'            => __('Status', 'invoicing'),
 		);
 
-		return apply_filters( 'manage_getpaid_subscriptions_table_columns', $columns );
+		return apply_filters('manage_getpaid_subscriptions_table_columns', $columns);
 	}
 
 	/**
@@ -355,15 +355,15 @@ 
 	 */
 	public function get_sortable_columns() {
 		$sortable = array(
-			'subscription' => array( 'id', true ),
-			'start_date'   => array( 'created', true ),
-			'renewal_date' => array( 'expiration', true ),
-			'renewals'     => array( 'bill_times', true ),
-			'item'         => array( 'product_id', true ),
-			'status'       => array( 'status', true ),
+			'subscription' => array('id', true),
+			'start_date'   => array('created', true),
+			'renewal_date' => array('expiration', true),
+			'renewals'     => array('bill_times', true),
+			'item'         => array('product_id', true),
+			'status'       => array('status', true),
 		);
 
-		return apply_filters( 'manage_getpaid_subscriptions_sortable_table_columns', $sortable );
+		return apply_filters('manage_getpaid_subscriptions_sortable_table_columns', $sortable);
 	}
 
 	/**
@@ -372,7 +372,7 @@ 
 	 * @return bool
 	 */
 	public function has_items() {
-		return ! empty( $this->current_total_count );
+		return !empty($this->current_total_count);
 	}
 
 	/**

includes/gateways/class-getpaid-payment-gateway.php

Indentation +568 added lines, -568 removed lines

@@ -13,449 +13,449 @@ 
  */
 abstract class GetPaid_Payment_Gateway {
 
-	/**
-	 * Set if the place checkout button should be renamed on selection.
-	 *
-	 * @var string
-	 */
-	public $checkout_button_text;
-
-	/**
-	 * Boolean whether the method is enabled.
-	 *
-	 * @var bool
-	 */
-	public $enabled = true;
-
-	/**
-	 * Payment method id.
-	 *
-	 * @var string
-	 */
-	public $id;
-
-	/**
-	 * Payment method order.
-	 *
-	 * @var int
-	 */
-	public $order = 10;
-
-	/**
-	 * Payment method title for the frontend.
-	 *
-	 * @var string
-	 */
-	public $title;
-
-	/**
-	 * Payment method description for the frontend.
-	 *
-	 * @var string
-	 */
-	public $description;
-
-	/**
-	 * Gateway title.
-	 *
-	 * @var string
-	 */
-	public $method_title = '';
-
-	/**
-	 * Gateway description.
-	 *
-	 * @var string
-	 */
-	public $method_description = '';
-
-	/**
-	 * Countries this gateway is allowed for.
-	 *
-	 * @var array
-	 */
-	public $countries;
-
-	/**
-	 * Currencies this gateway is allowed for.
-	 *
-	 * @var array
-	 */
-	public $currencies;
-
-	/**
-	 * Currencies this gateway is not allowed for.
-	 *
-	 * @var array
-	 */
-	public $exclude_currencies;
-
-	/**
-	 * Maximum transaction amount, zero does not define a maximum.
-	 *
-	 * @var int
-	 */
-	public $max_amount = 0;
-
-	/**
-	 * Optional URL to view a transaction.
-	 *
-	 * @var string
-	 */
-	public $view_transaction_url = '';
-
-	/**
-	 * Optional URL to view a subscription.
-	 *
-	 * @var string
-	 */
-	public $view_subscription_url = '';
-
-	/**
-	 * Optional label to show for "new payment method" in the payment
-	 * method/token selection radio selection.
-	 *
-	 * @var string
-	 */
-	public $new_method_label = '';
-
-	/**
-	 * Contains a user's saved tokens for this gateway.
-	 *
-	 * @var array
-	 */
-	protected $tokens = array();
-
-	/**
-	 * An array of features that this gateway supports.
-	 *
-	 * @var array
-	 */
-	protected $supports = array();
-
-	/**
-	 * Class constructor.
-	 */
-	public function __construct() {
-		$this->enabled = wpinv_is_gateway_active( $this->id );
-
-		// Register gateway.
-		add_filter( 'wpinv_payment_gateways', array( $this, 'register_gateway' ) );
-
-		// Enable Subscriptions.
-		if ( $this->supports( 'subscription' ) ) {
-			add_filter( "wpinv_{$this->id}_support_subscription", '__return_true' );
-		}
-
-		// Enable sandbox.
-		if ( $this->supports( 'sandbox' ) ) {
-			add_filter( "wpinv_{$this->id}_supports_sandbox", '__return_true' );
-		}
-
-		// Gateway settings.
-		add_filter( "wpinv_gateway_settings_{$this->id}", array( $this, 'admin_settings' ) );
+    /**
+     * Set if the place checkout button should be renamed on selection.
+     *
+     * @var string
+     */
+    public $checkout_button_text;
+
+    /**
+     * Boolean whether the method is enabled.
+     *
+     * @var bool
+     */
+    public $enabled = true;
+
+    /**
+     * Payment method id.
+     *
+     * @var string
+     */
+    public $id;
+
+    /**
+     * Payment method order.
+     *
+     * @var int
+     */
+    public $order = 10;
+
+    /**
+     * Payment method title for the frontend.
+     *
+     * @var string
+     */
+    public $title;
+
+    /**
+     * Payment method description for the frontend.
+     *
+     * @var string
+     */
+    public $description;
+
+    /**
+     * Gateway title.
+     *
+     * @var string
+     */
+    public $method_title = '';
+
+    /**
+     * Gateway description.
+     *
+     * @var string
+     */
+    public $method_description = '';
+
+    /**
+     * Countries this gateway is allowed for.
+     *
+     * @var array
+     */
+    public $countries;
+
+    /**
+     * Currencies this gateway is allowed for.
+     *
+     * @var array
+     */
+    public $currencies;
+
+    /**
+     * Currencies this gateway is not allowed for.
+     *
+     * @var array
+     */
+    public $exclude_currencies;
+
+    /**
+     * Maximum transaction amount, zero does not define a maximum.
+     *
+     * @var int
+     */
+    public $max_amount = 0;
+
+    /**
+     * Optional URL to view a transaction.
+     *
+     * @var string
+     */
+    public $view_transaction_url = '';
+
+    /**
+     * Optional URL to view a subscription.
+     *
+     * @var string
+     */
+    public $view_subscription_url = '';
+
+    /**
+     * Optional label to show for "new payment method" in the payment
+     * method/token selection radio selection.
+     *
+     * @var string
+     */
+    public $new_method_label = '';
+
+    /**
+     * Contains a user's saved tokens for this gateway.
+     *
+     * @var array
+     */
+    protected $tokens = array();
+
+    /**
+     * An array of features that this gateway supports.
+     *
+     * @var array
+     */
+    protected $supports = array();
+
+    /**
+     * Class constructor.
+     */
+    public function __construct() {
+        $this->enabled = wpinv_is_gateway_active( $this->id );
+
+        // Register gateway.
+        add_filter( 'wpinv_payment_gateways', array( $this, 'register_gateway' ) );
+
+        // Enable Subscriptions.
+        if ( $this->supports( 'subscription' ) ) {
+            add_filter( "wpinv_{$this->id}_support_subscription", '__return_true' );
+        }
+
+        // Enable sandbox.
+        if ( $this->supports( 'sandbox' ) ) {
+            add_filter( "wpinv_{$this->id}_supports_sandbox", '__return_true' );
+        }
+
+        // Gateway settings.
+        add_filter( "wpinv_gateway_settings_{$this->id}", array( $this, 'admin_settings' ) );
 		
 
-		// Gateway checkout fiellds.
-		add_action( "wpinv_{$this->id}_cc_form", array( $this, 'payment_fields' ), 10, 2 );
-
-		// Process payment.
-		add_action( "getpaid_gateway_{$this->id}", array( $this, 'process_payment' ), 10, 3 );
+        // Gateway checkout fiellds.
+        add_action( "wpinv_{$this->id}_cc_form", array( $this, 'payment_fields' ), 10, 2 );
+
+        // Process payment.
+        add_action( "getpaid_gateway_{$this->id}", array( $this, 'process_payment' ), 10, 3 );
+
+        // Change the checkout button text.
+        if ( ! empty( $this->checkout_button_text ) ) {
+            add_filter( "getpaid_gateway_{$this->id}_checkout_button_label", array( $this, 'rename_checkout_button' ) );
+        }
+
+        // Check if a gateway is valid for a given currency.
+        add_filter( "getpaid_gateway_{$this->id}_is_valid_for_currency", array( $this, 'validate_currency' ), 10, 2 );
+
+        // Generate the transaction url.
+        add_filter( "getpaid_gateway_{$this->id}_transaction_url", array( $this, 'filter_transaction_url' ), 10, 2 );
+
+        // Generate the subscription url.
+        add_filter( "getpaid_gateway_{$this->id}_subscription_url", array( $this, 'filter_subscription_url' ), 10, 2 );
+
+        // Confirm payments.
+        add_filter( "wpinv_payment_confirm_{$this->id}", array( $this, 'confirm_payment' ), 10, 2 );
+
+        // Verify IPNs.
+        add_action( "wpinv_verify_{$this->id}_ipn", array( $this, 'verify_ipn' ) );
+
+    }
+
+    /**
+     * Checks if this gateway is a given gateway.
+     *
+     * @since 1.0.19
+     * @return bool
+     */
+    public function is( $gateway ) {
+        return $gateway == $this->id;
+    }
+
+    /**
+     * Returns a users saved tokens for this gateway.
+     *
+     * @since 1.0.19
+     * @return array
+     */
+    public function get_tokens( $sandbox = null ) {
+
+        if ( is_user_logged_in() && $this->supports( 'tokens' ) && 0 == count( $this->tokens ) ) {
+            $tokens = get_user_meta( get_current_user_id(), "getpaid_{$this->id}_tokens", true );
+
+            if ( is_array( $tokens ) ) {
+                $this->tokens = $tokens;
+            }
+
+        }
+
+        if ( ! is_bool( $sandbox ) ) {
+            return $this->tokens;
+        }
+
+        $args = array( 'type' => $sandbox ? 'sandbox' : 'live' );
+        return wp_list_filter( $this->tokens, $args );
+
+    }
+
+    /**
+     * Saves a token for this gateway.
+     *
+     * @since 1.0.19
+     */
+    public function save_token( $token ) {
 
-		// Change the checkout button text.
-		if ( ! empty( $this->checkout_button_text ) ) {
-			add_filter( "getpaid_gateway_{$this->id}_checkout_button_label", array( $this, 'rename_checkout_button' ) );
-		}
-
-		// Check if a gateway is valid for a given currency.
-		add_filter( "getpaid_gateway_{$this->id}_is_valid_for_currency", array( $this, 'validate_currency' ), 10, 2 );
-
-		// Generate the transaction url.
-		add_filter( "getpaid_gateway_{$this->id}_transaction_url", array( $this, 'filter_transaction_url' ), 10, 2 );
-
-		// Generate the subscription url.
-		add_filter( "getpaid_gateway_{$this->id}_subscription_url", array( $this, 'filter_subscription_url' ), 10, 2 );
-
-		// Confirm payments.
-		add_filter( "wpinv_payment_confirm_{$this->id}", array( $this, 'confirm_payment' ), 10, 2 );
-
-		// Verify IPNs.
-		add_action( "wpinv_verify_{$this->id}_ipn", array( $this, 'verify_ipn' ) );
-
-	}
-
-	/**
-	 * Checks if this gateway is a given gateway.
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
-	public function is( $gateway ) {
-		return $gateway == $this->id;
-	}
-
-	/**
-	 * Returns a users saved tokens for this gateway.
-	 *
-	 * @since 1.0.19
-	 * @return array
-	 */
-	public function get_tokens( $sandbox = null ) {
-
-		if ( is_user_logged_in() && $this->supports( 'tokens' ) && 0 == count( $this->tokens ) ) {
-			$tokens = get_user_meta( get_current_user_id(), "getpaid_{$this->id}_tokens", true );
-
-			if ( is_array( $tokens ) ) {
-				$this->tokens = $tokens;
-			}
-
-		}
-
-		if ( ! is_bool( $sandbox ) ) {
-			return $this->tokens;
-		}
-
-		$args = array( 'type' => $sandbox ? 'sandbox' : 'live' );
-		return wp_list_filter( $this->tokens, $args );
-
-	}
-
-	/**
-	 * Saves a token for this gateway.
-	 *
-	 * @since 1.0.19
-	 */
-	public function save_token( $token ) {
-
-		$tokens   = $this->get_tokens();
-		$tokens[] = $token;
-
-		update_user_meta( get_current_user_id(), "getpaid_{$this->id}_tokens", $tokens );
-
-		$this->tokens = $tokens;
-
-	}
-
-	/**
-	 * Return the title for admin screens.
-	 *
-	 * @return string
-	 */
-	public function get_method_title() {
-		return apply_filters( 'getpaid_gateway_method_title', $this->method_title, $this );
-	}
-
-	/**
-	 * Return the description for admin screens.
-	 *
-	 * @return string
-	 */
-	public function get_method_description() {
-		return apply_filters( 'getpaid_gateway_method_description', $this->method_description, $this );
-	}
-
-	/**
-	 * Get the success url.
-	 *
-	 * @param WPInv_Invoice $invoice Invoice object.
-	 * @return string
-	 */
-	public function get_return_url( $invoice ) {
-
-		// Payment success url
-		$return_url = add_query_arg(
-			array(
-				'payment-confirm' => $this->id,
-				'invoice_key'     => $invoice->get_key(),
-				'utm_nooverride'  => 1
-			),
-			wpinv_get_success_page_uri()
-		);
-
-		return apply_filters( 'getpaid_gateway_success_url', $return_url, $invoice, $this );
-	}
-
-	/**
-	 * Confirms payments when rendering the success page.
-	 *
-	 * @param string $content Success page content.
-	 * @return string
-	 */
-	public function get_confirm_payment( $content ) {
+        $tokens   = $this->get_tokens();
+        $tokens[] = $token;
+
+        update_user_meta( get_current_user_id(), "getpaid_{$this->id}_tokens", $tokens );
+
+        $this->tokens = $tokens;
+
+    }
+
+    /**
+     * Return the title for admin screens.
+     *
+     * @return string
+     */
+    public function get_method_title() {
+        return apply_filters( 'getpaid_gateway_method_title', $this->method_title, $this );
+    }
+
+    /**
+     * Return the description for admin screens.
+     *
+     * @return string
+     */
+    public function get_method_description() {
+        return apply_filters( 'getpaid_gateway_method_description', $this->method_description, $this );
+    }
+
+    /**
+     * Get the success url.
+     *
+     * @param WPInv_Invoice $invoice Invoice object.
+     * @return string
+     */
+    public function get_return_url( $invoice ) {
+
+        // Payment success url
+        $return_url = add_query_arg(
+            array(
+                'payment-confirm' => $this->id,
+                'invoice_key'     => $invoice->get_key(),
+                'utm_nooverride'  => 1
+            ),
+            wpinv_get_success_page_uri()
+        );
+
+        return apply_filters( 'getpaid_gateway_success_url', $return_url, $invoice, $this );
+    }
+
+    /**
+     * Confirms payments when rendering the success page.
+     *
+     * @param string $content Success page content.
+     * @return string
+     */
+    public function get_confirm_payment( $content ) {
 		
-		// Retrieve the invoice.
-		$invoice_id = getpaid_get_current_invoice_id();
-		$invoice    = wpinv_get_invoice( $invoice_id );
+        // Retrieve the invoice.
+        $invoice_id = getpaid_get_current_invoice_id();
+        $invoice    = wpinv_get_invoice( $invoice_id );
 	
-		// Ensure that it exists and that it is pending payment.
-		if ( empty( $invoice_id ) || ! $invoice->needs_payment() ) {
-			return $content;
-		}
+        // Ensure that it exists and that it is pending payment.
+        if ( empty( $invoice_id ) || ! $invoice->needs_payment() ) {
+            return $content;
+        }
 	
-		// Can the user view this invoice??
-		if ( ! wpinv_user_can_view_invoice( $invoice ) ) {
-			return $content;
-		}
+        // Can the user view this invoice??
+        if ( ! wpinv_user_can_view_invoice( $invoice ) ) {
+            return $content;
+        }
 	
-		// Show payment processing indicator.
-		return wpinv_get_template_html( 'wpinv-payment-processing.php', compact( 'invoice' ) );
-	}
-
-	/**
-	 * Processes ipns and marks payments as complete.
-	 *
-	 * @return void
-	 */
-	public function verify_ipn() {}
-
-	/**
-	 * Get a link to the transaction on the 3rd party gateway site (if applicable).
-	 *
-	 * @param string $transaction_url transaction url.
-	 * @param WPInv_Invoice $invoice Invoice object.
-	 * @return string transaction URL, or empty string.
-	 */
-	public function filter_transaction_url( $transaction_url, $invoice ) {
-
-		$transaction_id  = $invoice->get_transaction_id();
-
-		if ( ! empty( $this->view_transaction_url ) && ! empty( $transaction_id ) ) {
-			$transaction_url = sprintf( $this->view_transaction_url, $transaction_id );
-			$replace         = $this->is_sandbox( $invoice ) ? 'sandbox' : '';
-			$transaction_url = str_replace( '{sandbox}', $replace, $transaction_url );
-		}
-
-		return $transaction_url;
-	}
-
-	/**
-	 * Get a link to the subscription on the 3rd party gateway site (if applicable).
-	 *
-	 * @param string $subscription_url transaction url.
-	 * @param WPInv_Invoice $invoice Invoice object.
-	 * @return string subscription URL, or empty string.
-	 */
-	public function filter_subscription_url( $subscription_url, $invoice ) {
-
-		$profile_id      = $invoice->get_subscription_id();
-
-		if ( ! empty( $this->view_subscription_url ) && ! empty( $profile_id ) ) {
-
-			$subscription_url = sprintf( $this->view_subscription_url, $profile_id );
-			$replace          = $this->is_sandbox( $invoice ) ? 'sandbox' : '';
-			$subscription_url = str_replace( '{sandbox}', $replace, $subscription_url );
-
-		}
-
-		return $subscription_url;
-	}
-
-	/**
-	 * Check if the gateway is available for use.
-	 *
-	 * @return bool
-	 */
-	public function is_available() {
-		return ! empty( $this->enabled );
-	}
-
-	/**
-	 * Return the gateway's title.
-	 *
-	 * @return string
-	 */
-	public function get_title() {
-		return apply_filters( 'getpaid_gateway_title', $this->title, $this );
-	}
-
-	/**
-	 * Return the gateway's description.
-	 *
-	 * @return string
-	 */
-	public function get_description() {
-		return apply_filters( 'getpaid_gateway_description', $this->description, $this );
-	}
-
-	/**
-	 * Process Payment.
-	 *
-	 *
-	 * @param WPInv_Invoice $invoice Invoice.
-	 * @param array $submission_data Posted checkout fields.
-	 * @param GetPaid_Payment_Form_Submission $submission Checkout submission.
-	 * @return void
-	 */
-	public function process_payment( $invoice, $submission_data, $submission ) {
-		// Process the payment then either redirect to the success page or the gateway.
-		do_action( 'getpaid_process_invoice_payment_' . $this->id, $invoice, $submission_data, $submission );
-	}
-
-	/**
-	 * Process refund.
-	 *
-	 * If the gateway declares 'refunds' support, this will allow it to refund.
-	 * a passed in amount.
-	 *
-	 * @param WPInv_Invoice $invoice Invoice.
-	 * @param  float  $amount Refund amount.
-	 * @param  string $reason Refund reason.
-	 * @return WP_Error|bool True or false based on success, or a WP_Error object.
-	 */
-	public function process_refund( $invoice, $amount = null, $reason = '' ) {
-		return apply_filters( 'getpaid_process_invoice_refund_' . $this->id, false, $invoice, $amount, $reason );
-	}
-
-	/**
-	 * Displays the payment fields, credit cards etc.
-	 * 
-	 * @param int $invoice_id 0 or invoice id.
-	 * @param GetPaid_Payment_Form $form Current payment form.
-	 */
-	public function payment_fields( $invoice_id, $form ) {
-		do_action( 'getpaid_getpaid_gateway_payment_fields_' . $this->id, $invoice_id, $form );
-	}
-
-	/**
-	 * Filters the gateway settings.
-	 * 
-	 * @param array $admin_settings
-	 */
-	public function admin_settings( $admin_settings ) {
-		return $admin_settings;
-	}
-
-	/**
-	 * Retrieves the value of a gateway setting.
-	 * 
-	 * @param string $option
-	 */
-	public function get_option( $option, $default = false ) {
-		return wpinv_get_option( $this->id . '_' . $option, $default );
-	}
-
-	/**
-	 * Check if a gateway supports a given feature.
-	 *
-	 * Gateways should override this to declare support (or lack of support) for a feature.
-	 * For backward compatibility, gateways support 'products' by default, but nothing else.
-	 *
-	 * @param string $feature string The name of a feature to test support for.
-	 * @return bool True if the gateway supports the feature, false otherwise.
-	 * @since 1.0.19
-	 */
-	public function supports( $feature ) {
-		return apply_filters( 'getpaid_payment_gateway_supports', in_array( $feature, $this->supports ), $feature, $this );
-	}
-
-	/**
-	 * Returns the credit card form html.
-	 * 
-	 * @param bool $save whether or not to display the save button.
-	 */
+        // Show payment processing indicator.
+        return wpinv_get_template_html( 'wpinv-payment-processing.php', compact( 'invoice' ) );
+    }
+
+    /**
+     * Processes ipns and marks payments as complete.
+     *
+     * @return void
+     */
+    public function verify_ipn() {}
+
+    /**
+     * Get a link to the transaction on the 3rd party gateway site (if applicable).
+     *
+     * @param string $transaction_url transaction url.
+     * @param WPInv_Invoice $invoice Invoice object.
+     * @return string transaction URL, or empty string.
+     */
+    public function filter_transaction_url( $transaction_url, $invoice ) {
+
+        $transaction_id  = $invoice->get_transaction_id();
+
+        if ( ! empty( $this->view_transaction_url ) && ! empty( $transaction_id ) ) {
+            $transaction_url = sprintf( $this->view_transaction_url, $transaction_id );
+            $replace         = $this->is_sandbox( $invoice ) ? 'sandbox' : '';
+            $transaction_url = str_replace( '{sandbox}', $replace, $transaction_url );
+        }
+
+        return $transaction_url;
+    }
+
+    /**
+     * Get a link to the subscription on the 3rd party gateway site (if applicable).
+     *
+     * @param string $subscription_url transaction url.
+     * @param WPInv_Invoice $invoice Invoice object.
+     * @return string subscription URL, or empty string.
+     */
+    public function filter_subscription_url( $subscription_url, $invoice ) {
+
+        $profile_id      = $invoice->get_subscription_id();
+
+        if ( ! empty( $this->view_subscription_url ) && ! empty( $profile_id ) ) {
+
+            $subscription_url = sprintf( $this->view_subscription_url, $profile_id );
+            $replace          = $this->is_sandbox( $invoice ) ? 'sandbox' : '';
+            $subscription_url = str_replace( '{sandbox}', $replace, $subscription_url );
+
+        }
+
+        return $subscription_url;
+    }
+
+    /**
+     * Check if the gateway is available for use.
+     *
+     * @return bool
+     */
+    public function is_available() {
+        return ! empty( $this->enabled );
+    }
+
+    /**
+     * Return the gateway's title.
+     *
+     * @return string
+     */
+    public function get_title() {
+        return apply_filters( 'getpaid_gateway_title', $this->title, $this );
+    }
+
+    /**
+     * Return the gateway's description.
+     *
+     * @return string
+     */
+    public function get_description() {
+        return apply_filters( 'getpaid_gateway_description', $this->description, $this );
+    }
+
+    /**
+     * Process Payment.
+     *
+     *
+     * @param WPInv_Invoice $invoice Invoice.
+     * @param array $submission_data Posted checkout fields.
+     * @param GetPaid_Payment_Form_Submission $submission Checkout submission.
+     * @return void
+     */
+    public function process_payment( $invoice, $submission_data, $submission ) {
+        // Process the payment then either redirect to the success page or the gateway.
+        do_action( 'getpaid_process_invoice_payment_' . $this->id, $invoice, $submission_data, $submission );
+    }
+
+    /**
+     * Process refund.
+     *
+     * If the gateway declares 'refunds' support, this will allow it to refund.
+     * a passed in amount.
+     *
+     * @param WPInv_Invoice $invoice Invoice.
+     * @param  float  $amount Refund amount.
+     * @param  string $reason Refund reason.
+     * @return WP_Error|bool True or false based on success, or a WP_Error object.
+     */
+    public function process_refund( $invoice, $amount = null, $reason = '' ) {
+        return apply_filters( 'getpaid_process_invoice_refund_' . $this->id, false, $invoice, $amount, $reason );
+    }
+
+    /**
+     * Displays the payment fields, credit cards etc.
+     * 
+     * @param int $invoice_id 0 or invoice id.
+     * @param GetPaid_Payment_Form $form Current payment form.
+     */
+    public function payment_fields( $invoice_id, $form ) {
+        do_action( 'getpaid_getpaid_gateway_payment_fields_' . $this->id, $invoice_id, $form );
+    }
+
+    /**
+     * Filters the gateway settings.
+     * 
+     * @param array $admin_settings
+     */
+    public function admin_settings( $admin_settings ) {
+        return $admin_settings;
+    }
+
+    /**
+     * Retrieves the value of a gateway setting.
+     * 
+     * @param string $option
+     */
+    public function get_option( $option, $default = false ) {
+        return wpinv_get_option( $this->id . '_' . $option, $default );
+    }
+
+    /**
+     * Check if a gateway supports a given feature.
+     *
+     * Gateways should override this to declare support (or lack of support) for a feature.
+     * For backward compatibility, gateways support 'products' by default, but nothing else.
+     *
+     * @param string $feature string The name of a feature to test support for.
+     * @return bool True if the gateway supports the feature, false otherwise.
+     * @since 1.0.19
+     */
+    public function supports( $feature ) {
+        return apply_filters( 'getpaid_payment_gateway_supports', in_array( $feature, $this->supports ), $feature, $this );
+    }
+
+    /**
+     * Returns the credit card form html.
+     * 
+     * @param bool $save whether or not to display the save button.
+     */
     public function get_cc_form( $save = false ) {
 
-		ob_start();
+        ob_start();
 
         $id_prefix = esc_attr( uniqid( $this->id ) );
 
@@ -561,175 +561,175 @@ 
 					
 					<?php
 
-						if ( $save ) {
-							echo $this->save_payment_method_checkbox();
-						}
+                        if ( $save ) {
+                            echo $this->save_payment_method_checkbox();
+                        }
 
-					?>
+                    ?>
                 </div>
 
             </div>
 		<?php
 		
-		return ob_get_clean();
+        return ob_get_clean();
+
+    }
+
+    /**
+     * Displays a new payment method entry form.
+     *
+     * @since 1.0.19
+     */
+    public function new_payment_method_entry( $form ) {
+        echo "<div class='getpaid-new-payment-method-form' style='display:none;'>$form</div>";
+    }
+
+    /**
+     * Grab and display our saved payment methods.
+     *
+     * @since 1.0.19
+     */
+    public function saved_payment_methods() {
+        $html = '<ul class="getpaid-saved-payment-methods m-0 mt-2" data-count="' . esc_attr( count( $this->get_tokens( $this->is_sandbox() ) ) ) . '">';
+
+        foreach ( $this->get_tokens( $this->is_sandbox() ) as $token ) {
+            $html .= $this->get_saved_payment_method_option_html( $token );
+        }
 
+        $html .= $this->get_new_payment_method_option_html();
+        $html .= '</ul>';
+
+        echo apply_filters( 'getpaid_payment_gateway_form_saved_payment_methods_html', $html, $this );
     }
 
-	/**
-	 * Displays a new payment method entry form.
-	 *
-	 * @since 1.0.19
-	 */
-	public function new_payment_method_entry( $form ) {
-		echo "<div class='getpaid-new-payment-method-form' style='display:none;'>$form</div>";
-	}
-
-	/**
-	 * Grab and display our saved payment methods.
-	 *
-	 * @since 1.0.19
-	 */
-	public function saved_payment_methods() {
-		$html = '<ul class="getpaid-saved-payment-methods m-0 mt-2" data-count="' . esc_attr( count( $this->get_tokens( $this->is_sandbox() ) ) ) . '">';
-
-		foreach ( $this->get_tokens( $this->is_sandbox() ) as $token ) {
-			$html .= $this->get_saved_payment_method_option_html( $token );
-		}
-
-		$html .= $this->get_new_payment_method_option_html();
-		$html .= '</ul>';
-
-		echo apply_filters( 'getpaid_payment_gateway_form_saved_payment_methods_html', $html, $this );
-	}
-
-	/**
-	 * Gets saved payment method HTML from a token.
-	 *
-	 * @since 1.0.19
-	 * @param  array $token Payment Token.
-	 * @return string Generated payment method HTML
-	 */
-	public function get_saved_payment_method_option_html( $token ) {
-
-		return sprintf(
-			'<li class="getpaid-payment-method form-group">
+    /**
+     * Gets saved payment method HTML from a token.
+     *
+     * @since 1.0.19
+     * @param  array $token Payment Token.
+     * @return string Generated payment method HTML
+     */
+    public function get_saved_payment_method_option_html( $token ) {
+
+        return sprintf(
+            '<li class="getpaid-payment-method form-group">
 				<label>
 					<input name="getpaid-%1$s-payment-method" type="radio" value="%2$s" style="width:auto;" class="getpaid-saved-payment-method-token-input" %4$s />
 					<span>%3$s</span>
 				</label>
 			</li>',
-			esc_attr( $this->id ),
-			esc_attr( $token['id'] ),
-			esc_html( $token['name'] ),
-			checked( empty( $token['default'] ), false, false )
-		);
+            esc_attr( $this->id ),
+            esc_attr( $token['id'] ),
+            esc_html( $token['name'] ),
+            checked( empty( $token['default'] ), false, false )
+        );
 
-	}
+    }
 
-	/**
-	 * Displays a radio button for entering a new payment method (new CC details) instead of using a saved method.
-	 *
-	 * @since 1.0.19
-	 */
-	public function get_new_payment_method_option_html() {
+    /**
+     * Displays a radio button for entering a new payment method (new CC details) instead of using a saved method.
+     *
+     * @since 1.0.19
+     */
+    public function get_new_payment_method_option_html() {
 
-		$label = apply_filters( 'getpaid_new_payment_method_label', $this->new_method_label ? $this->new_method_label : __( 'Use a new payment method', 'invoicing' ), $this );
+        $label = apply_filters( 'getpaid_new_payment_method_label', $this->new_method_label ? $this->new_method_label : __( 'Use a new payment method', 'invoicing' ), $this );
 
-		return sprintf(
-			'<li class="getpaid-new-payment-method">
+        return sprintf(
+            '<li class="getpaid-new-payment-method">
 				<label>
 					<input name="getpaid-%1$s-payment-method" type="radio" value="new" style="width:auto;" />
 					<span>%2$s</span>
 				</label>
 			</li>',
-			esc_attr( $this->id ),
-			esc_html( $label )
-		);
+            esc_attr( $this->id ),
+            esc_html( $label )
+        );
 
-	}
+    }
 
-	/**
-	 * Outputs a checkbox for saving a new payment method to the database.
-	 *
-	 * @since 1.0.19
-	 */
-	public function save_payment_method_checkbox() {
+    /**
+     * Outputs a checkbox for saving a new payment method to the database.
+     *
+     * @since 1.0.19
+     */
+    public function save_payment_method_checkbox() {
 
-		return sprintf(
-			'<p class="form-group getpaid-save-payment-method">
+        return sprintf(
+            '<p class="form-group getpaid-save-payment-method">
 				<label>
 					<input name="getpaid-%1$s-new-payment-method" type="checkbox" value="true" style="width:auto;" />
 					<span>%2$s</span>
 				</label>
 			</p>',
-			esc_attr( $this->id ),
-			esc_html__( 'Save payment method', 'invoicing' )
-		);
+            esc_attr( $this->id ),
+            esc_html__( 'Save payment method', 'invoicing' )
+        );
 
-	}
+    }
 
-	/**
-	 * Registers the gateway.
-	 *
-	 * @return array
-	 */
-	public function register_gateway( $gateways ) {
+    /**
+     * Registers the gateway.
+     *
+     * @return array
+     */
+    public function register_gateway( $gateways ) {
 
-		$gateways[ $this->id ] = array(
+        $gateways[ $this->id ] = array(
 
-			'admin_label'    => $this->method_title,
+            'admin_label'    => $this->method_title,
             'checkout_label' => $this->title,
-			'ordering'       => $this->order,
-
-		);
-
-		return $gateways;
-
-	}
-
-	/**
-	 * Checks whether or not this is a sandbox request.
-	 *
-	 * @param  WPInv_Invoice|null $invoice Invoice object or null.
-	 * @return bool
-	 */
-	public function is_sandbox( $invoice = null ) {
-
-		if ( ! empty( $invoice ) && ! $invoice->needs_payment() ) {
-			return $invoice->get_mode() == 'test';
-		}
-
-		return wpinv_is_test_mode( $this->id );
-
-	}
-
-	/**
-	 * Renames the checkout button
-	 *
-	 * @return string
-	 */
-	public function rename_checkout_button() {
-		return $this->checkout_button_text;
-	}
-
-	/**
-	 * Validate gateway currency
-	 *
-	 * @return bool
-	 */
-	public function validate_currency( $validation, $currency ) {
-
-		// Required currencies.
-		if ( ! empty( $this->currencies ) && ! in_array( $currency, $this->currencies ) ) {
-			return false;
-		}
-
-		// Excluded currencies.
-		if ( ! empty( $this->exclude_currencies ) && in_array( $currency, $this->exclude_currencies ) ) {
-			return false;
-		}
-
-		return $validation;
-	}
+            'ordering'       => $this->order,
+
+        );
+
+        return $gateways;
+
+    }
+
+    /**
+     * Checks whether or not this is a sandbox request.
+     *
+     * @param  WPInv_Invoice|null $invoice Invoice object or null.
+     * @return bool
+     */
+    public function is_sandbox( $invoice = null ) {
+
+        if ( ! empty( $invoice ) && ! $invoice->needs_payment() ) {
+            return $invoice->get_mode() == 'test';
+        }
+
+        return wpinv_is_test_mode( $this->id );
+
+    }
+
+    /**
+     * Renames the checkout button
+     *
+     * @return string
+     */
+    public function rename_checkout_button() {
+        return $this->checkout_button_text;
+    }
+
+    /**
+     * Validate gateway currency
+     *
+     * @return bool
+     */
+    public function validate_currency( $validation, $currency ) {
+
+        // Required currencies.
+        if ( ! empty( $this->currencies ) && ! in_array( $currency, $this->currencies ) ) {
+            return false;
+        }
+
+        // Excluded currencies.
+        if ( ! empty( $this->exclude_currencies ) && in_array( $currency, $this->exclude_currencies ) ) {
+            return false;
+        }
+
+        return $validation;
+    }
 
 }

Spacing +117 added lines, -117 removed lines

@@ -4,7 +4,7 @@ 
  *
  */
 
-defined( 'ABSPATH' ) || exit;
+defined('ABSPATH') || exit;
 
 /**
  * Abstaract Payment Gateway class.
@@ -137,50 +137,50 @@ 
 	 * Class constructor.
 	 */
 	public function __construct() {
-		$this->enabled = wpinv_is_gateway_active( $this->id );
+		$this->enabled = wpinv_is_gateway_active($this->id);
 
 		// Register gateway.
-		add_filter( 'wpinv_payment_gateways', array( $this, 'register_gateway' ) );
+		add_filter('wpinv_payment_gateways', array($this, 'register_gateway'));
 
 		// Enable Subscriptions.
-		if ( $this->supports( 'subscription' ) ) {
-			add_filter( "wpinv_{$this->id}_support_subscription", '__return_true' );
+		if ($this->supports('subscription')) {
+			add_filter("wpinv_{$this->id}_support_subscription", '__return_true');
 		}
 
 		// Enable sandbox.
-		if ( $this->supports( 'sandbox' ) ) {
-			add_filter( "wpinv_{$this->id}_supports_sandbox", '__return_true' );
+		if ($this->supports('sandbox')) {
+			add_filter("wpinv_{$this->id}_supports_sandbox", '__return_true');
 		}
 
 		// Gateway settings.
-		add_filter( "wpinv_gateway_settings_{$this->id}", array( $this, 'admin_settings' ) );
+		add_filter("wpinv_gateway_settings_{$this->id}", array($this, 'admin_settings'));
 		
 
 		// Gateway checkout fiellds.
-		add_action( "wpinv_{$this->id}_cc_form", array( $this, 'payment_fields' ), 10, 2 );
+		add_action("wpinv_{$this->id}_cc_form", array($this, 'payment_fields'), 10, 2);
 
 		// Process payment.
-		add_action( "getpaid_gateway_{$this->id}", array( $this, 'process_payment' ), 10, 3 );
+		add_action("getpaid_gateway_{$this->id}", array($this, 'process_payment'), 10, 3);
 
 		// Change the checkout button text.
-		if ( ! empty( $this->checkout_button_text ) ) {
-			add_filter( "getpaid_gateway_{$this->id}_checkout_button_label", array( $this, 'rename_checkout_button' ) );
+		if (!empty($this->checkout_button_text)) {
+			add_filter("getpaid_gateway_{$this->id}_checkout_button_label", array($this, 'rename_checkout_button'));
 		}
 
 		// Check if a gateway is valid for a given currency.
-		add_filter( "getpaid_gateway_{$this->id}_is_valid_for_currency", array( $this, 'validate_currency' ), 10, 2 );
+		add_filter("getpaid_gateway_{$this->id}_is_valid_for_currency", array($this, 'validate_currency'), 10, 2);
 
 		// Generate the transaction url.
-		add_filter( "getpaid_gateway_{$this->id}_transaction_url", array( $this, 'filter_transaction_url' ), 10, 2 );
+		add_filter("getpaid_gateway_{$this->id}_transaction_url", array($this, 'filter_transaction_url'), 10, 2);
 
 		// Generate the subscription url.
-		add_filter( "getpaid_gateway_{$this->id}_subscription_url", array( $this, 'filter_subscription_url' ), 10, 2 );
+		add_filter("getpaid_gateway_{$this->id}_subscription_url", array($this, 'filter_subscription_url'), 10, 2);
 
 		// Confirm payments.
-		add_filter( "wpinv_payment_confirm_{$this->id}", array( $this, 'confirm_payment' ), 10, 2 );
+		add_filter("wpinv_payment_confirm_{$this->id}", array($this, 'confirm_payment'), 10, 2);
 
 		// Verify IPNs.
-		add_action( "wpinv_verify_{$this->id}_ipn", array( $this, 'verify_ipn' ) );
+		add_action("wpinv_verify_{$this->id}_ipn", array($this, 'verify_ipn'));
 
 	}
 
@@ -190,7 +190,7 @@ 
 	 * @since 1.0.19
 	 * @return bool
 	 */
-	public function is( $gateway ) {
+	public function is($gateway) {
 		return $gateway == $this->id;
 	}
 
@@ -200,23 +200,23 @@ 
 	 * @since 1.0.19
 	 * @return array
 	 */
-	public function get_tokens( $sandbox = null ) {
+	public function get_tokens($sandbox = null) {
 
-		if ( is_user_logged_in() && $this->supports( 'tokens' ) && 0 == count( $this->tokens ) ) {
-			$tokens = get_user_meta( get_current_user_id(), "getpaid_{$this->id}_tokens", true );
+		if (is_user_logged_in() && $this->supports('tokens') && 0 == count($this->tokens)) {
+			$tokens = get_user_meta(get_current_user_id(), "getpaid_{$this->id}_tokens", true);
 
-			if ( is_array( $tokens ) ) {
+			if (is_array($tokens)) {
 				$this->tokens = $tokens;
 			}
 
 		}
 
-		if ( ! is_bool( $sandbox ) ) {
+		if (!is_bool($sandbox)) {
 			return $this->tokens;
 		}
 
-		$args = array( 'type' => $sandbox ? 'sandbox' : 'live' );
-		return wp_list_filter( $this->tokens, $args );
+		$args = array('type' => $sandbox ? 'sandbox' : 'live');
+		return wp_list_filter($this->tokens, $args);
 
 	}
 
@@ -225,12 +225,12 @@ 
 	 *
 	 * @since 1.0.19
 	 */
-	public function save_token( $token ) {
+	public function save_token($token) {
 
 		$tokens   = $this->get_tokens();
 		$tokens[] = $token;
 
-		update_user_meta( get_current_user_id(), "getpaid_{$this->id}_tokens", $tokens );
+		update_user_meta(get_current_user_id(), "getpaid_{$this->id}_tokens", $tokens);
 
 		$this->tokens = $tokens;
 
@@ -242,7 +242,7 @@ 
 	 * @return string
 	 */
 	public function get_method_title() {
-		return apply_filters( 'getpaid_gateway_method_title', $this->method_title, $this );
+		return apply_filters('getpaid_gateway_method_title', $this->method_title, $this);
 	}
 
 	/**
@@ -251,7 +251,7 @@ 
 	 * @return string
 	 */
 	public function get_method_description() {
-		return apply_filters( 'getpaid_gateway_method_description', $this->method_description, $this );
+		return apply_filters('getpaid_gateway_method_description', $this->method_description, $this);
 	}
 
 	/**
@@ -260,7 +260,7 @@ 
 	 * @param WPInv_Invoice $invoice Invoice object.
 	 * @return string
 	 */
-	public function get_return_url( $invoice ) {
+	public function get_return_url($invoice) {
 
 		// Payment success url
 		$return_url = add_query_arg(
@@ -272,7 +272,7 @@ 
 			wpinv_get_success_page_uri()
 		);
 
-		return apply_filters( 'getpaid_gateway_success_url', $return_url, $invoice, $this );
+		return apply_filters('getpaid_gateway_success_url', $return_url, $invoice, $this);
 	}
 
 	/**
@@ -281,24 +281,24 @@ 
 	 * @param string $content Success page content.
 	 * @return string
 	 */
-	public function get_confirm_payment( $content ) {
+	public function get_confirm_payment($content) {
 		
 		// Retrieve the invoice.
 		$invoice_id = getpaid_get_current_invoice_id();
-		$invoice    = wpinv_get_invoice( $invoice_id );
+		$invoice    = wpinv_get_invoice($invoice_id);
 	
 		// Ensure that it exists and that it is pending payment.
-		if ( empty( $invoice_id ) || ! $invoice->needs_payment() ) {
+		if (empty($invoice_id) || !$invoice->needs_payment()) {
 			return $content;
 		}
 	
 		// Can the user view this invoice??
-		if ( ! wpinv_user_can_view_invoice( $invoice ) ) {
+		if (!wpinv_user_can_view_invoice($invoice)) {
 			return $content;
 		}
 	
 		// Show payment processing indicator.
-		return wpinv_get_template_html( 'wpinv-payment-processing.php', compact( 'invoice' ) );
+		return wpinv_get_template_html('wpinv-payment-processing.php', compact('invoice'));
 	}
 
 	/**
@@ -315,14 +315,14 @@ 
 	 * @param WPInv_Invoice $invoice Invoice object.
 	 * @return string transaction URL, or empty string.
 	 */
-	public function filter_transaction_url( $transaction_url, $invoice ) {
+	public function filter_transaction_url($transaction_url, $invoice) {
 
-		$transaction_id  = $invoice->get_transaction_id();
+		$transaction_id = $invoice->get_transaction_id();
 
-		if ( ! empty( $this->view_transaction_url ) && ! empty( $transaction_id ) ) {
-			$transaction_url = sprintf( $this->view_transaction_url, $transaction_id );
-			$replace         = $this->is_sandbox( $invoice ) ? 'sandbox' : '';
-			$transaction_url = str_replace( '{sandbox}', $replace, $transaction_url );
+		if (!empty($this->view_transaction_url) && !empty($transaction_id)) {
+			$transaction_url = sprintf($this->view_transaction_url, $transaction_id);
+			$replace         = $this->is_sandbox($invoice) ? 'sandbox' : '';
+			$transaction_url = str_replace('{sandbox}', $replace, $transaction_url);
 		}
 
 		return $transaction_url;
@@ -335,15 +335,15 @@ 
 	 * @param WPInv_Invoice $invoice Invoice object.
 	 * @return string subscription URL, or empty string.
 	 */
-	public function filter_subscription_url( $subscription_url, $invoice ) {
+	public function filter_subscription_url($subscription_url, $invoice) {
 
-		$profile_id      = $invoice->get_subscription_id();
+		$profile_id = $invoice->get_subscription_id();
 
-		if ( ! empty( $this->view_subscription_url ) && ! empty( $profile_id ) ) {
+		if (!empty($this->view_subscription_url) && !empty($profile_id)) {
 
-			$subscription_url = sprintf( $this->view_subscription_url, $profile_id );
-			$replace          = $this->is_sandbox( $invoice ) ? 'sandbox' : '';
-			$subscription_url = str_replace( '{sandbox}', $replace, $subscription_url );
+			$subscription_url = sprintf($this->view_subscription_url, $profile_id);
+			$replace          = $this->is_sandbox($invoice) ? 'sandbox' : '';
+			$subscription_url = str_replace('{sandbox}', $replace, $subscription_url);
 
 		}
 
@@ -356,7 +356,7 @@ 
 	 * @return bool
 	 */
 	public function is_available() {
-		return ! empty( $this->enabled );
+		return !empty($this->enabled);
 	}
 
 	/**
@@ -365,7 +365,7 @@ 
 	 * @return string
 	 */
 	public function get_title() {
-		return apply_filters( 'getpaid_gateway_title', $this->title, $this );
+		return apply_filters('getpaid_gateway_title', $this->title, $this);
 	}
 
 	/**
@@ -374,7 +374,7 @@ 
 	 * @return string
 	 */
 	public function get_description() {
-		return apply_filters( 'getpaid_gateway_description', $this->description, $this );
+		return apply_filters('getpaid_gateway_description', $this->description, $this);
 	}
 
 	/**
@@ -386,9 +386,9 @@ 
 	 * @param GetPaid_Payment_Form_Submission $submission Checkout submission.
 	 * @return void
 	 */
-	public function process_payment( $invoice, $submission_data, $submission ) {
+	public function process_payment($invoice, $submission_data, $submission) {
 		// Process the payment then either redirect to the success page or the gateway.
-		do_action( 'getpaid_process_invoice_payment_' . $this->id, $invoice, $submission_data, $submission );
+		do_action('getpaid_process_invoice_payment_' . $this->id, $invoice, $submission_data, $submission);
 	}
 
 	/**
@@ -402,8 +402,8 @@ 
 	 * @param  string $reason Refund reason.
 	 * @return WP_Error|bool True or false based on success, or a WP_Error object.
 	 */
-	public function process_refund( $invoice, $amount = null, $reason = '' ) {
-		return apply_filters( 'getpaid_process_invoice_refund_' . $this->id, false, $invoice, $amount, $reason );
+	public function process_refund($invoice, $amount = null, $reason = '') {
+		return apply_filters('getpaid_process_invoice_refund_' . $this->id, false, $invoice, $amount, $reason);
 	}
 
 	/**
@@ -412,8 +412,8 @@ 
 	 * @param int $invoice_id 0 or invoice id.
 	 * @param GetPaid_Payment_Form $form Current payment form.
 	 */
-	public function payment_fields( $invoice_id, $form ) {
-		do_action( 'getpaid_getpaid_gateway_payment_fields_' . $this->id, $invoice_id, $form );
+	public function payment_fields($invoice_id, $form) {
+		do_action('getpaid_getpaid_gateway_payment_fields_' . $this->id, $invoice_id, $form);
 	}
 
 	/**
@@ -421,7 +421,7 @@ 
 	 * 
 	 * @param array $admin_settings
 	 */
-	public function admin_settings( $admin_settings ) {
+	public function admin_settings($admin_settings) {
 		return $admin_settings;
 	}
 
@@ -430,8 +430,8 @@ 
 	 * 
 	 * @param string $option
 	 */
-	public function get_option( $option, $default = false ) {
-		return wpinv_get_option( $this->id . '_' . $option, $default );
+	public function get_option($option, $default = false) {
+		return wpinv_get_option($this->id . '_' . $option, $default);
 	}
 
 	/**
@@ -444,8 +444,8 @@ 
 	 * @return bool True if the gateway supports the feature, false otherwise.
 	 * @since 1.0.19
 	 */
-	public function supports( $feature ) {
-		return apply_filters( 'getpaid_payment_gateway_supports', in_array( $feature, $this->supports ), $feature, $this );
+	public function supports($feature) {
+		return apply_filters('getpaid_payment_gateway_supports', in_array($feature, $this->supports), $feature, $this);
 	}
 
 	/**
@@ -453,36 +453,36 @@ 
 	 * 
 	 * @param bool $save whether or not to display the save button.
 	 */
-    public function get_cc_form( $save = false ) {
+    public function get_cc_form($save = false) {
 
 		ob_start();
 
-        $id_prefix = esc_attr( uniqid( $this->id ) );
+        $id_prefix = esc_attr(uniqid($this->id));
 
         $months = array(
-            '01' => __( 'January', 'invoicing' ),
-            '02' => __( 'February', 'invoicing' ),
-            '03' => __( 'March', 'invoicing' ),
-            '04' => __( 'April', 'invoicing' ),
-            '05' => __( 'May', 'invoicing' ),
-            '06' => __( 'June', 'invoicing' ),
-            '07' => __( 'July', 'invoicing' ),
-            '08' => __( 'August', 'invoicing' ),
-            '09' => __( 'September', 'invoicing' ),
-            '10' => __( 'October', 'invoicing' ),
-            '11' => __( 'November', 'invoicing' ),
-            '12' => __( 'December', 'invoicing' ),
+            '01' => __('January', 'invoicing'),
+            '02' => __('February', 'invoicing'),
+            '03' => __('March', 'invoicing'),
+            '04' => __('April', 'invoicing'),
+            '05' => __('May', 'invoicing'),
+            '06' => __('June', 'invoicing'),
+            '07' => __('July', 'invoicing'),
+            '08' => __('August', 'invoicing'),
+            '09' => __('September', 'invoicing'),
+            '10' => __('October', 'invoicing'),
+            '11' => __('November', 'invoicing'),
+            '12' => __('December', 'invoicing'),
         );
 
-        $year  = (int) date( 'Y', current_time( 'timestamp' ) );
+        $year  = (int) date('Y', current_time('timestamp'));
         $years = array();
 
-        for ( $i = 0; $i <= 10; $i++ ) {
-            $years[ $year + $i ] = $year + $i;
+        for ($i = 0; $i <= 10; $i++) {
+            $years[$year + $i] = $year + $i;
         }
 
         ?>
-            <div class="<?php echo esc_attr( $this->id );?>-cc-form getpaid-cc-form card  mt-4">
+            <div class="<?php echo esc_attr($this->id); ?>-cc-form getpaid-cc-form card  mt-4">
 
 
                 <div class="card-body">
@@ -496,7 +496,7 @@ 
                                     array(
                                         'name'              => $this->id . '[cc_number]',
                                         'id'                => "$id_prefix-cc-number",
-                                        'label'             => __( 'Card number', 'invoicing' ),
+                                        'label'             => __('Card number', 'invoicing'),
                                         'label_type'        => 'vertical',
                                         'input_group_left'  => '<span class="input-group-text"><i class="fa fa-credit-card"></i></span>',
                                     )
@@ -507,17 +507,17 @@ 
 
                         <div class="col-12 col-sm-4">
                             <div class="form-group">
-                                <label><?php _e( 'Expiration', 'invoicing' ); ?></label>
+                                <label><?php _e('Expiration', 'invoicing'); ?></label>
                                 <div class="form-row">
 
                                     <div class="col">
-                                        <select class="form-control" name="<?php echo esc_attr( $this->id );?>[cc_expire_month]">
-                                            <option disabled selected="selected"><?php _e( 'MM', 'invoicing' ); ?></option>
+                                        <select class="form-control" name="<?php echo esc_attr($this->id); ?>[cc_expire_month]">
+                                            <option disabled selected="selected"><?php _e('MM', 'invoicing'); ?></option>
 
                                             <?php
-                                                foreach ( $months as $key => $month ) {
-                                                    $key   = esc_attr( $key );
-                                                    $month = wpinv_clean( $month );
+                                                foreach ($months as $key => $month) {
+                                                    $key   = esc_attr($key);
+                                                    $month = wpinv_clean($month);
                                                     echo "<option value='$key'>$month</option>" . PHP_EOL;
                                                 }
                                             ?>
@@ -526,13 +526,13 @@ 
                                     </div>
 
                                     <div class="col">
-                                        <select class="form-control" name="<?php echo esc_attr( $this->id );?>[cc_expire_year]">
-                                            <option disabled selected="selected"><?php _e( 'YY', 'invoicing' ); ?></option>
+                                        <select class="form-control" name="<?php echo esc_attr($this->id); ?>[cc_expire_year]">
+                                            <option disabled selected="selected"><?php _e('YY', 'invoicing'); ?></option>
 
                                             <?php
-                                                foreach ( $years as $key => $year ) {
-                                                    $key   = esc_attr( $key );
-                                                    $year  = wpinv_clean( $year );
+                                                foreach ($years as $key => $year) {
+                                                    $key   = esc_attr($key);
+                                                    $year  = wpinv_clean($year);
                                                     echo "<option value='$key'>$year</option>" . PHP_EOL;
                                                 }
                                             ?>
@@ -550,7 +550,7 @@ 
                                     array(
                                         'name'              => $this->id . '[cc_cvv2]',
                                         'id'                => "$id_prefix-cc-cvv2",
-                                        'label'             => __( 'CCV', 'invoicing' ),
+                                        'label'             => __('CCV', 'invoicing'),
                                         'label_type'        => 'vertical',
                                     )
                                 );
@@ -561,7 +561,7 @@ 
 					
 					<?php
 
-						if ( $save ) {
+						if ($save) {
 							echo $this->save_payment_method_checkbox();
 						}
 
@@ -580,7 +580,7 @@ 
 	 *
 	 * @since 1.0.19
 	 */
-	public function new_payment_method_entry( $form ) {
+	public function new_payment_method_entry($form) {
 		echo "<div class='getpaid-new-payment-method-form' style='display:none;'>$form</div>";
 	}
 
@@ -590,16 +590,16 @@ 
 	 * @since 1.0.19
 	 */
 	public function saved_payment_methods() {
-		$html = '<ul class="getpaid-saved-payment-methods m-0 mt-2" data-count="' . esc_attr( count( $this->get_tokens( $this->is_sandbox() ) ) ) . '">';
+		$html = '<ul class="getpaid-saved-payment-methods m-0 mt-2" data-count="' . esc_attr(count($this->get_tokens($this->is_sandbox()))) . '">';
 
-		foreach ( $this->get_tokens( $this->is_sandbox() ) as $token ) {
-			$html .= $this->get_saved_payment_method_option_html( $token );
+		foreach ($this->get_tokens($this->is_sandbox()) as $token) {
+			$html .= $this->get_saved_payment_method_option_html($token);
 		}
 
 		$html .= $this->get_new_payment_method_option_html();
 		$html .= '</ul>';
 
-		echo apply_filters( 'getpaid_payment_gateway_form_saved_payment_methods_html', $html, $this );
+		echo apply_filters('getpaid_payment_gateway_form_saved_payment_methods_html', $html, $this);
 	}
 
 	/**
@@ -609,7 +609,7 @@ 
 	 * @param  array $token Payment Token.
 	 * @return string Generated payment method HTML
 	 */
-	public function get_saved_payment_method_option_html( $token ) {
+	public function get_saved_payment_method_option_html($token) {
 
 		return sprintf(
 			'<li class="getpaid-payment-method form-group">
@@ -618,10 +618,10 @@ 
 					<span>%3$s</span>
 				</label>
 			</li>',
-			esc_attr( $this->id ),
-			esc_attr( $token['id'] ),
-			esc_html( $token['name'] ),
-			checked( empty( $token['default'] ), false, false )
+			esc_attr($this->id),
+			esc_attr($token['id']),
+			esc_html($token['name']),
+			checked(empty($token['default']), false, false)
 		);
 
 	}
@@ -633,7 +633,7 @@ 
 	 */
 	public function get_new_payment_method_option_html() {
 
-		$label = apply_filters( 'getpaid_new_payment_method_label', $this->new_method_label ? $this->new_method_label : __( 'Use a new payment method', 'invoicing' ), $this );
+		$label = apply_filters('getpaid_new_payment_method_label', $this->new_method_label ? $this->new_method_label : __('Use a new payment method', 'invoicing'), $this);
 
 		return sprintf(
 			'<li class="getpaid-new-payment-method">
@@ -642,8 +642,8 @@ 
 					<span>%2$s</span>
 				</label>
 			</li>',
-			esc_attr( $this->id ),
-			esc_html( $label )
+			esc_attr($this->id),
+			esc_html($label)
 		);
 
 	}
@@ -662,8 +662,8 @@ 
 					<span>%2$s</span>
 				</label>
 			</p>',
-			esc_attr( $this->id ),
-			esc_html__( 'Save payment method', 'invoicing' )
+			esc_attr($this->id),
+			esc_html__('Save payment method', 'invoicing')
 		);
 
 	}
@@ -673,9 +673,9 @@ 
 	 *
 	 * @return array
 	 */
-	public function register_gateway( $gateways ) {
+	public function register_gateway($gateways) {
 
-		$gateways[ $this->id ] = array(
+		$gateways[$this->id] = array(
 
 			'admin_label'    => $this->method_title,
             'checkout_label' => $this->title,
@@ -693,13 +693,13 @@ 
 	 * @param  WPInv_Invoice|null $invoice Invoice object or null.
 	 * @return bool
 	 */
-	public function is_sandbox( $invoice = null ) {
+	public function is_sandbox($invoice = null) {
 
-		if ( ! empty( $invoice ) && ! $invoice->needs_payment() ) {
+		if (!empty($invoice) && !$invoice->needs_payment()) {
 			return $invoice->get_mode() == 'test';
 		}
 
-		return wpinv_is_test_mode( $this->id );
+		return wpinv_is_test_mode($this->id);
 
 	}
 
@@ -717,15 +717,15 @@ 
 	 *
 	 * @return bool
 	 */
-	public function validate_currency( $validation, $currency ) {
+	public function validate_currency($validation, $currency) {
 
 		// Required currencies.
-		if ( ! empty( $this->currencies ) && ! in_array( $currency, $this->currencies ) ) {
+		if (!empty($this->currencies) && !in_array($currency, $this->currencies)) {
 			return false;
 		}
 
 		// Excluded currencies.
-		if ( ! empty( $this->exclude_currencies ) && in_array( $currency, $this->exclude_currencies ) ) {
+		if (!empty($this->exclude_currencies) && in_array($currency, $this->exclude_currencies)) {
 			return false;
 		}
 

includes/admin/class-wpinv-admin-menus.php

Spacing +98 added lines, -98 removed lines

@@ -3,7 +3,7 @@ 
  * Setup menus in WP admin.
  */
 
-defined( 'ABSPATH' ) || exit;
+defined('ABSPATH') || exit;
 
 /**
  * WC_Admin_Menus Class.
@@ -13,25 +13,25 @@ 
      * Hook in tabs.
      */
     public function __construct() {
-        add_action( 'admin_menu', array( $this, 'admin_menu' ), 10 );
-        add_action( 'admin_menu', array( $this, 'add_customers_menu' ), 18 );
-        add_action( 'admin_menu', array( $this, 'add_subscriptions_menu' ), 40 );
-        add_action( 'admin_menu', array( $this, 'add_addons_menu' ), 100 );
-        add_action( 'admin_menu', array( $this, 'add_settings_menu' ), 60 );
-        add_action( 'admin_menu', array( $this, 'remove_admin_submenus' ), 10 );
-        add_action( 'admin_head-nav-menus.php', array( $this, 'add_nav_menu_meta_boxes' ) );
+        add_action('admin_menu', array($this, 'admin_menu'), 10);
+        add_action('admin_menu', array($this, 'add_customers_menu'), 18);
+        add_action('admin_menu', array($this, 'add_subscriptions_menu'), 40);
+        add_action('admin_menu', array($this, 'add_addons_menu'), 100);
+        add_action('admin_menu', array($this, 'add_settings_menu'), 60);
+        add_action('admin_menu', array($this, 'remove_admin_submenus'), 10);
+        add_action('admin_head-nav-menus.php', array($this, 'add_nav_menu_meta_boxes'));
     }
 
     public function admin_menu() {
 
-        $capability = apply_filters( 'invoicing_capability', wpinv_get_capability() );
+        $capability = apply_filters('invoicing_capability', wpinv_get_capability());
         add_menu_page(
-            __( 'GetPaid', 'invoicing' ),
-            __( 'GetPaid', 'invoicing' ),
+            __('GetPaid', 'invoicing'),
+            __('GetPaid', 'invoicing'),
             $capability,
             'wpinv',
             null,
-            'data:image/svg+xml;base64,' . base64_encode( file_get_contents( WPINV_PLUGIN_DIR . 'assets/images/GetPaid.svg' ) ),
+            'data:image/svg+xml;base64,' . base64_encode(file_get_contents(WPINV_PLUGIN_DIR . 'assets/images/GetPaid.svg')),
             '54.123460'
         );
 
@@ -43,11 +43,11 @@ 
     public function add_customers_menu() {
         add_submenu_page(
             'wpinv',
-            __( 'Customers', 'invoicing' ),
-            __( 'Customers', 'invoicing' ),
+            __('Customers', 'invoicing'),
+            __('Customers', 'invoicing'),
             wpinv_get_capability(),
             'wpinv-customers',
-            array( $this, 'customers_page' )
+            array($this, 'customers_page')
         );
     }
 
@@ -57,8 +57,8 @@ 
     public function add_subscriptions_menu() {
         add_submenu_page(
             'wpinv',
-            __( 'Subscriptions', 'invoicing' ),
-            __( 'Subscriptions', 'invoicing' ),
+            __('Subscriptions', 'invoicing'),
+            __('Subscriptions', 'invoicing'),
             wpinv_get_capability(),
             'wpinv-subscriptions',
             'wpinv_subscriptions_page'
@@ -69,7 +69,7 @@ 
      * Displays the customers page.
      */
     public function customers_page() {
-        require_once( WPINV_PLUGIN_DIR . 'includes/admin/class-wpinv-customers-table.php' );
+        require_once(WPINV_PLUGIN_DIR . 'includes/admin/class-wpinv-customers-table.php');
         ?>
         <div class="wrap wpi-customers-wrap">
             <style>
@@ -77,7 +77,7 @@ 
                     width: 30%;
                 }
             </style>
-            <h1><?php echo esc_html( __( 'Customers', 'invoicing' ) ); ?></h1>
+            <h1><?php echo esc_html(__('Customers', 'invoicing')); ?></h1>
             <?php
                 $table = new WPInv_Customers_Table();
                 $table->prepare_items();
@@ -93,16 +93,16 @@ 
     public function add_settings_menu() {
         add_submenu_page(
             'wpinv',
-            __( 'Invoice Settings', 'invoicing' ),
-            __( 'Settings', 'invoicing' ),
-            apply_filters( 'invoicing_capability', wpinv_get_capability() ),
+            __('Invoice Settings', 'invoicing'),
+            __('Settings', 'invoicing'),
+            apply_filters('invoicing_capability', wpinv_get_capability()),
             'wpinv-settings',
-            array( $this, 'options_page' )
+            array($this, 'options_page')
         );
     }
 
-    public function add_addons_menu(){
-        if ( !apply_filters( 'wpi_show_addons_page', true ) ) {
+    public function add_addons_menu() {
+        if (!apply_filters('wpi_show_addons_page', true)) {
             return;
         }
 
@@ -112,78 +112,78 @@ 
             __('Extensions', 'invoicing'),
             'manage_options',
             'wpi-addons',
-            array( $this, 'addons_page' )
+            array($this, 'addons_page')
         );
     }
 
-    public function addons_page(){
+    public function addons_page() {
         $addon_obj = new WPInv_Admin_Addons();
         $addon_obj->output();
     }
 
     function options_page() {
-        $page       = isset( $_GET['page'] )                ? strtolower( $_GET['page'] )               : false;
+        $page = isset($_GET['page']) ? strtolower($_GET['page']) : false;
 
-        if ( $page !== 'wpinv-settings' ) {
+        if ($page !== 'wpinv-settings') {
             return;
         }
 
         $settings_tabs = wpinv_get_settings_tabs();
         $settings_tabs = empty($settings_tabs) ? array() : $settings_tabs;
-        $active_tab    = isset( $_GET['tab'] ) && array_key_exists( $_GET['tab'], $settings_tabs ) ? sanitize_text_field( $_GET['tab'] ) : 'general';
-        $sections      = wpinv_get_settings_tab_sections( $active_tab );
+        $active_tab    = isset($_GET['tab']) && array_key_exists($_GET['tab'], $settings_tabs) ? sanitize_text_field($_GET['tab']) : 'general';
+        $sections      = wpinv_get_settings_tab_sections($active_tab);
         $key           = 'main';
 
-        if ( is_array( $sections ) ) {
-            $key = key( $sections );
+        if (is_array($sections)) {
+            $key = key($sections);
         }
 
-        $registered_sections = wpinv_get_settings_tab_sections( $active_tab );
-        $section             = isset( $_GET['section'] ) && ! empty( $registered_sections ) && array_key_exists( $_GET['section'], $registered_sections ) ? $_GET['section'] : $key;
+        $registered_sections = wpinv_get_settings_tab_sections($active_tab);
+        $section             = isset($_GET['section']) && !empty($registered_sections) && array_key_exists($_GET['section'], $registered_sections) ? $_GET['section'] : $key;
         ob_start();
         ?>
         <div class="wrap">
             <h1 class="nav-tab-wrapper">
                 <?php
-                foreach( wpinv_get_settings_tabs() as $tab_id => $tab_name ) {
-                    $tab_url = add_query_arg( array(
+                foreach (wpinv_get_settings_tabs() as $tab_id => $tab_name) {
+                    $tab_url = add_query_arg(array(
                         'settings-updated' => false,
                         'tab' => $tab_id,
-                    ) );
+                    ));
 
                     // Remove the section from the tabs so we always end up at the main section
-                    $tab_url = remove_query_arg( 'section', $tab_url );
-                    $tab_url = remove_query_arg( 'wpi_sub', $tab_url );
+                    $tab_url = remove_query_arg('section', $tab_url);
+                    $tab_url = remove_query_arg('wpi_sub', $tab_url);
 
                     $active = $active_tab == $tab_id ? ' nav-tab-active' : '';
 
-                    echo '<a href="' . esc_url( $tab_url ) . '" title="' . esc_attr( $tab_name ) . '" class="nav-tab' . $active . '">';
-                    echo esc_html( $tab_name );
+                    echo '<a href="' . esc_url($tab_url) . '" title="' . esc_attr($tab_name) . '" class="nav-tab' . $active . '">';
+                    echo esc_html($tab_name);
                     echo '</a>';
                 }
                 ?>
             </h1>
             <?php
-            $number_of_sections = count( $sections );
+            $number_of_sections = count($sections);
             $number = 0;
-            if ( $number_of_sections > 1 ) {
+            if ($number_of_sections > 1) {
                 echo '<div><ul class="subsubsub">';
-                foreach( $sections as $section_id => $section_name ) {
+                foreach ($sections as $section_id => $section_name) {
                     echo '<li>';
                     $number++;
-                    $tab_url = add_query_arg( array(
+                    $tab_url = add_query_arg(array(
                         'settings-updated' => false,
                         'tab' => $active_tab,
                         'section' => $section_id
-                    ) );
-                    $tab_url = remove_query_arg( 'wpi_sub', $tab_url );
+                    ));
+                    $tab_url = remove_query_arg('wpi_sub', $tab_url);
                     $class = '';
-                    if ( $section == $section_id ) {
+                    if ($section == $section_id) {
                         $class = 'current';
                     }
-                    echo '<a class="' . $class . '" href="' . esc_url( $tab_url ) . '">' . $section_name . '</a>';
+                    echo '<a class="' . $class . '" href="' . esc_url($tab_url) . '">' . $section_name . '</a>';
 
-                    if ( $number != $number_of_sections ) {
+                    if ($number != $number_of_sections) {
                         echo ' | ';
                     }
                     echo '</li>';
@@ -195,19 +195,19 @@ 
                 <form method="post" action="options.php">
                     <table class="form-table">
                         <?php
-                        settings_fields( 'wpinv_settings' );
+                        settings_fields('wpinv_settings');
 
-                        if ( 'main' === $section ) {
-                            do_action( 'wpinv_settings_tab_top', $active_tab );
+                        if ('main' === $section) {
+                            do_action('wpinv_settings_tab_top', $active_tab);
                         }
 
-                        do_action( 'wpinv_settings_tab_top_' . $active_tab . '_' . $section, $active_tab, $section );
-                        do_settings_sections( 'wpinv_settings_' . $active_tab . '_' . $section, $active_tab, $section );
-                        do_action( 'wpinv_settings_tab_bottom_' . $active_tab . '_' . $section, $active_tab, $section );
+                        do_action('wpinv_settings_tab_top_' . $active_tab . '_' . $section, $active_tab, $section);
+                        do_settings_sections('wpinv_settings_' . $active_tab . '_' . $section, $active_tab, $section);
+                        do_action('wpinv_settings_tab_bottom_' . $active_tab . '_' . $section, $active_tab, $section);
 
                         // For backwards compatibility
-                        if ( 'main' === $section ) {
-                            do_action( 'wpinv_settings_tab_bottom', $active_tab );
+                        if ('main' === $section) {
+                            do_action('wpinv_settings_tab_bottom', $active_tab);
                         }
                         ?>
                     </table>
@@ -221,18 +221,18 @@ 
     }
 
     public function remove_admin_submenus() {
-        remove_submenu_page( 'edit.php?post_type=wpi_invoice', 'post-new.php?post_type=wpi_invoice' );
+        remove_submenu_page('edit.php?post_type=wpi_invoice', 'post-new.php?post_type=wpi_invoice');
     }
 
-    public function add_nav_menu_meta_boxes(){
-        add_meta_box( 'wpinv_endpoints_nav_link', __( 'Invoicing Pages', 'invoicing' ), array( $this, 'nav_menu_links' ), 'nav-menus', 'side', 'low' );
+    public function add_nav_menu_meta_boxes() {
+        add_meta_box('wpinv_endpoints_nav_link', __('Invoicing Pages', 'invoicing'), array($this, 'nav_menu_links'), 'nav-menus', 'side', 'low');
     }
 
-    public function nav_menu_links(){
+    public function nav_menu_links() {
         $endpoints = $this->get_menu_items();
         ?>
         <div id="invoicing-endpoints" class="posttypediv">
-        <?php if(!empty($endpoints['pages'])){ ?>
+        <?php if (!empty($endpoints['pages'])) { ?>
             <div id="tabs-panel-invoicing-endpoints" class="tabs-panel tabs-panel-active">
                 <ul id="invoicing-endpoints-checklist" class="categorychecklist form-no-clear">
                     <?php
@@ -244,29 +244,29 @@ 
         <?php } ?>
         <p class="button-controls">
         <span class="list-controls">
-            <a href="<?php echo admin_url( 'nav-menus.php?page-tab=all&selectall=1#invoicing-endpoints' ); ?>" class="select-all"><?php _e( 'Select all', 'invoicing' ); ?></a>
+            <a href="<?php echo admin_url('nav-menus.php?page-tab=all&selectall=1#invoicing-endpoints'); ?>" class="select-all"><?php _e('Select all', 'invoicing'); ?></a>
         </span>
             <span class="add-to-menu">
-            <input type="submit" class="button-secondary submit-add-to-menu right" value="<?php esc_attr_e( 'Add to menu', 'invoicing' ); ?>" name="add-post-type-menu-item" id="submit-invoicing-endpoints">
+            <input type="submit" class="button-secondary submit-add-to-menu right" value="<?php esc_attr_e('Add to menu', 'invoicing'); ?>" name="add-post-type-menu-item" id="submit-invoicing-endpoints">
             <span class="spinner"></span>
         </span>
         </p>
         <?php
     }
 
-    public function get_menu_items(){
+    public function get_menu_items() {
         $items = array();
 
-        $wpinv_history_page_id = (int)wpinv_get_option( 'invoice_history_page' );
-        if($wpinv_history_page_id > 0){
+        $wpinv_history_page_id = (int) wpinv_get_option('invoice_history_page');
+        if ($wpinv_history_page_id > 0) {
             $item = new stdClass();
             $item->object_id = $wpinv_history_page_id;
             $item->db_id = 0;
-            $item->object =  'page';
+            $item->object = 'page';
             $item->menu_item_parent = 0;
             $item->type = 'post_type';
-            $item->title = __('Invoice History Page','invoicing');
-            $item->url = get_permalink( $wpinv_history_page_id );
+            $item->title = __('Invoice History Page', 'invoicing');
+            $item->url = get_permalink($wpinv_history_page_id);
             $item->target = '';
             $item->attr_title = '';
             $item->classes = array('wpinv-menu-item');
@@ -275,16 +275,16 @@ 
             $items['pages'][] = $item;
         }
 
-        $wpinv_sub_history_page_id = (int)wpinv_get_option( 'invoice_subscription_page' );
-        if($wpinv_sub_history_page_id > 0){
+        $wpinv_sub_history_page_id = (int) wpinv_get_option('invoice_subscription_page');
+        if ($wpinv_sub_history_page_id > 0) {
             $item = new stdClass();
             $item->object_id = $wpinv_sub_history_page_id;
             $item->db_id = 0;
-            $item->object =  'page';
+            $item->object = 'page';
             $item->menu_item_parent = 0;
             $item->type = 'post_type';
-            $item->title = __('Invoice Subscriptions Page','invoicing');
-            $item->url = get_permalink( $wpinv_sub_history_page_id );
+            $item->title = __('Invoice Subscriptions Page', 'invoicing');
+            $item->url = get_permalink($wpinv_sub_history_page_id);
             $item->target = '';
             $item->attr_title = '';
             $item->classes = array('wpinv-menu-item');
@@ -293,16 +293,16 @@ 
             $items['pages'][] = $item;
         }
 
-        $wpinv_checkout_page_id = (int)wpinv_get_option( 'checkout_page' );
-        if($wpinv_checkout_page_id > 0){
+        $wpinv_checkout_page_id = (int) wpinv_get_option('checkout_page');
+        if ($wpinv_checkout_page_id > 0) {
             $item = new stdClass();
             $item->object_id = $wpinv_checkout_page_id;
             $item->db_id = 0;
-            $item->object =  'page';
+            $item->object = 'page';
             $item->menu_item_parent = 0;
             $item->type = 'post_type';
-            $item->title = __('Checkout Page','invoicing');
-            $item->url = get_permalink( $wpinv_checkout_page_id );
+            $item->title = __('Checkout Page', 'invoicing');
+            $item->url = get_permalink($wpinv_checkout_page_id);
             $item->target = '';
             $item->attr_title = '';
             $item->classes = array('wpinv-menu-item');
@@ -311,16 +311,16 @@ 
             $items['pages'][] = $item;
         }
 
-        $wpinv_tandc_page_id = (int)wpinv_get_option( 'tandc_page' );
-        if($wpinv_tandc_page_id > 0){
+        $wpinv_tandc_page_id = (int) wpinv_get_option('tandc_page');
+        if ($wpinv_tandc_page_id > 0) {
             $item = new stdClass();
             $item->object_id = $wpinv_tandc_page_id;
             $item->db_id = 0;
-            $item->object =  'page';
+            $item->object = 'page';
             $item->menu_item_parent = 0;
             $item->type = 'post_type';
-            $item->title = __('Terms & Conditions','invoicing');
-            $item->url = get_permalink( $wpinv_tandc_page_id );
+            $item->title = __('Terms & Conditions', 'invoicing');
+            $item->url = get_permalink($wpinv_tandc_page_id);
             $item->target = '';
             $item->attr_title = '';
             $item->classes = array('wpinv-menu-item');
@@ -329,16 +329,16 @@ 
             $items['pages'][] = $item;
         }
 
-        $wpinv_success_page_id = (int)wpinv_get_option( 'success_page' );
-        if($wpinv_success_page_id > 0){
+        $wpinv_success_page_id = (int) wpinv_get_option('success_page');
+        if ($wpinv_success_page_id > 0) {
             $item = new stdClass();
             $item->object_id = $wpinv_success_page_id;
             $item->db_id = 0;
-            $item->object =  'page';
+            $item->object = 'page';
             $item->menu_item_parent = 0;
             $item->type = 'post_type';
-            $item->title = __('Success Page','invoicing');
-            $item->url = get_permalink( $wpinv_success_page_id );
+            $item->title = __('Success Page', 'invoicing');
+            $item->url = get_permalink($wpinv_success_page_id);
             $item->target = '';
             $item->attr_title = '';
             $item->classes = array('wpinv-menu-item');
@@ -347,16 +347,16 @@ 
             $items['pages'][] = $item;
         }
 
-        $wpinv_failure_page_id = (int)wpinv_get_option( 'failure_page' );
-        if($wpinv_failure_page_id > 0){
+        $wpinv_failure_page_id = (int) wpinv_get_option('failure_page');
+        if ($wpinv_failure_page_id > 0) {
             $item = new stdClass();
             $item->object_id = $wpinv_failure_page_id;
             $item->db_id = 0;
-            $item->object =  'page';
+            $item->object = 'page';
             $item->menu_item_parent = 0;
             $item->type = 'post_type';
-            $item->title = __('Failed Transaction Page','invoicing');
-            $item->url = get_permalink( $wpinv_failure_page_id );
+            $item->title = __('Failed Transaction Page', 'invoicing');
+            $item->url = get_permalink($wpinv_failure_page_id);
             $item->target = '';
             $item->attr_title = '';
             $item->classes = array('wpinv-menu-item');
@@ -365,7 +365,7 @@ 
             $items['pages'][] = $item;
         }
 
-        return apply_filters( 'wpinv_menu_items', $items );
+        return apply_filters('wpinv_menu_items', $items);
     }
 
 }

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 +102 added lines, -102 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,29 +120,29 @@ 
      * @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 = add_query_arg(
@@ -152,7 +152,7 @@ 
             )
         );
 
-        wp_safe_redirect( esc_url( $redirect ) );
+        wp_safe_redirect(esc_url($redirect));
         exit;
 
     }
@@ -164,15 +164,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);
 
     }
 
@@ -183,31 +183,31 @@ 
      * @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;
         }
 
         // (Maybe) create a new subscription.
-        if ( ! $invoice->get_subscription_id() ) {
-            return $this->maybe_create_invoice_subscription( $invoice );
+        if (!$invoice->get_subscription_id()) {
+            return $this->maybe_create_invoice_subscription($invoice);
         }
 
-        $subscription = new WPInv_Subscription( $invoice->get_subscription_id() );
+        $subscription = new WPInv_Subscription($invoice->get_subscription_id());
 
         // In case the subscription was deleted...
-        if ( ! $subscription->get_id() ) {
-            return $this->maybe_create_invoice_subscription( $invoice );
+        if (!$subscription->get_id()) {
+            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);
 
     }
 
@@ -219,55 +219,55 @@ 
      * @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_free() || ! $invoice->is_recurring() ) {
+        if ($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);
         return $subscription->save();
 
     }
@@ -278,21 +278,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'));
 
         }
 
@@ -304,25 +304,25 @@ 
      * @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()) {
 
-            $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 ) ) {
+            if ($subscription->add_payment($args)) {
                 $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'));
             } else {
-                getpaid_admin()->show_error( __( 'We are unable to renew this subscription as the parent invoice does not exist.', 'invoicing' ) );
+                getpaid_admin()->show_error(__('We are unable to renew this subscription as the parent invoice does not exist.', '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(),
             'item_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', 'getpaid-license-manager' ) . '</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', 'getpaid-license-manager') . '</a>';
         }
 
         return $actions;

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

Indentation +209 added lines, -209 removed lines

@@ -4,7 +4,7 @@ 
  *
  */
 if ( ! defined( 'ABSPATH' ) ) {
-	exit;
+    exit;
 }
 
 /**
@@ -14,228 +14,228 @@ 
  */
 class GetPaid_Item_Data_Store extends GetPaid_Data_Store_WP {
 
-	/**
-	 * Data stored in meta keys, but not considered "meta" for an item.
-	 *
-	 * @since 1.0.19
-	 * @var array
-	 */
-	protected $internal_meta_keys = array(
-		'_wpinv_price',
-		'_wpinv_vat_rule',
-		'_wpinv_vat_class',
-		'_wpinv_type',
-		'_wpinv_custom_id',
-		'_wpinv_custom_name',
-		'_wpinv_custom_singular_name',
-		'_wpinv_editable',
-		'_wpinv_dynamic_pricing',
-		'_minimum_price',
-		'_wpinv_is_recurring',
-		'_wpinv_recurring_period',
-		'_wpinv_recurring_interval',
-		'_wpinv_recurring_limit',
-		'_wpinv_free_trial',
-		'_wpinv_trial_period',
-		'_wpinv_trial_interval'
-	);
-
-	/**
-	 * A map of meta keys to data props.
-	 *
-	 * @since 1.0.19
-	 *
-	 * @var array
-	 */
-	protected $meta_key_to_props = array(
-		'_wpinv_price'                => 'price',
-		'_wpinv_vat_rule'             => 'vat_rule',
-		'_wpinv_vat_class'            => 'vat_class',
-		'_wpinv_type'                 => 'type',
-		'_wpinv_custom_id'            => 'custom_id',
-		'_wpinv_custom_name'          => 'custom_name',
-		'_wpinv_custom_singular_name' => 'custom_singular_name',
-		'_wpinv_editable'             => 'is_editable',
-		'_wpinv_dynamic_pricing'      => 'is_dynamic_pricing',
-		'_minimum_price'              => 'minimum_price',
-		'_wpinv_custom_name'          => 'custom_name',
-		'_wpinv_is_recurring'         => 'is_recurring',
-		'_wpinv_recurring_period'     => 'recurring_period',
-		'_wpinv_recurring_interval'   => 'recurring_interval',
-		'_wpinv_recurring_limit'      => 'recurring_limit',
-		'_wpinv_free_trial'           => 'is_free_trial',
-		'_wpinv_trial_period'         => 'trial_period',
-		'_wpinv_trial_interval'       => 'trial_interval',
-		'_wpinv_version'              => 'version',
-	);
-
-	/*
+    /**
+     * Data stored in meta keys, but not considered "meta" for an item.
+     *
+     * @since 1.0.19
+     * @var array
+     */
+    protected $internal_meta_keys = array(
+        '_wpinv_price',
+        '_wpinv_vat_rule',
+        '_wpinv_vat_class',
+        '_wpinv_type',
+        '_wpinv_custom_id',
+        '_wpinv_custom_name',
+        '_wpinv_custom_singular_name',
+        '_wpinv_editable',
+        '_wpinv_dynamic_pricing',
+        '_minimum_price',
+        '_wpinv_is_recurring',
+        '_wpinv_recurring_period',
+        '_wpinv_recurring_interval',
+        '_wpinv_recurring_limit',
+        '_wpinv_free_trial',
+        '_wpinv_trial_period',
+        '_wpinv_trial_interval'
+    );
+
+    /**
+     * A map of meta keys to data props.
+     *
+     * @since 1.0.19
+     *
+     * @var array
+     */
+    protected $meta_key_to_props = array(
+        '_wpinv_price'                => 'price',
+        '_wpinv_vat_rule'             => 'vat_rule',
+        '_wpinv_vat_class'            => 'vat_class',
+        '_wpinv_type'                 => 'type',
+        '_wpinv_custom_id'            => 'custom_id',
+        '_wpinv_custom_name'          => 'custom_name',
+        '_wpinv_custom_singular_name' => 'custom_singular_name',
+        '_wpinv_editable'             => 'is_editable',
+        '_wpinv_dynamic_pricing'      => 'is_dynamic_pricing',
+        '_minimum_price'              => 'minimum_price',
+        '_wpinv_custom_name'          => 'custom_name',
+        '_wpinv_is_recurring'         => 'is_recurring',
+        '_wpinv_recurring_period'     => 'recurring_period',
+        '_wpinv_recurring_interval'   => 'recurring_interval',
+        '_wpinv_recurring_limit'      => 'recurring_limit',
+        '_wpinv_free_trial'           => 'is_free_trial',
+        '_wpinv_trial_period'         => 'trial_period',
+        '_wpinv_trial_interval'       => 'trial_interval',
+        '_wpinv_version'              => 'version',
+    );
+
+    /*
 	|--------------------------------------------------------------------------
 	| CRUD Methods
 	|--------------------------------------------------------------------------
 	*/
 
-	/**
-	 * Method to create a new item in the database.
-	 *
-	 * @param WPInv_Item $item Item object.
-	 */
-	public function create( &$item ) {
-		$item->set_version( WPINV_VERSION );
-		$item->set_date_created( current_time('mysql') );
-
-		// Create a new post.
-		$id = wp_insert_post(
-			apply_filters(
-				'getpaid_new_item_data',
-				array(
-					'post_date'     => $item->get_date_created( 'edit' ),
-					'post_type'     => 'wpi_item',
-					'post_status'   => $this->get_post_status( $item ),
-					'ping_status'   => 'closed',
-					'post_author'   => $item->get_author( 'edit' ),
-					'post_title'    => $item->get_name( 'edit' ),
-					'post_parent'   => 0,
-					'post_excerpt'  => $item->get_description( 'edit' ),
-				)
-			),
-			true
-		);
-
-		if ( $id && ! is_wp_error( $id ) ) {
-			$item->set_id( $id );
-			$this->update_post_meta( $item );
-			$item->save_meta_data();
-			$item->apply_changes();
-			$this->clear_caches( $item );
-			do_action( 'getpaid_new_item', $item );
-			return true;
-		}
-
-		if ( is_wp_error( $id ) ) {
-			$item->last_error = $id->get_error_message();
-		}
+    /**
+     * Method to create a new item in the database.
+     *
+     * @param WPInv_Item $item Item object.
+     */
+    public function create( &$item ) {
+        $item->set_version( WPINV_VERSION );
+        $item->set_date_created( current_time('mysql') );
+
+        // Create a new post.
+        $id = wp_insert_post(
+            apply_filters(
+                'getpaid_new_item_data',
+                array(
+                    'post_date'     => $item->get_date_created( 'edit' ),
+                    'post_type'     => 'wpi_item',
+                    'post_status'   => $this->get_post_status( $item ),
+                    'ping_status'   => 'closed',
+                    'post_author'   => $item->get_author( 'edit' ),
+                    'post_title'    => $item->get_name( 'edit' ),
+                    'post_parent'   => 0,
+                    'post_excerpt'  => $item->get_description( 'edit' ),
+                )
+            ),
+            true
+        );
+
+        if ( $id && ! is_wp_error( $id ) ) {
+            $item->set_id( $id );
+            $this->update_post_meta( $item );
+            $item->save_meta_data();
+            $item->apply_changes();
+            $this->clear_caches( $item );
+            do_action( 'getpaid_new_item', $item );
+            return true;
+        }
+
+        if ( is_wp_error( $id ) ) {
+            $item->last_error = $id->get_error_message();
+        }
 		
-		return false;
-	}
-
-	/**
-	 * Method to read an item from the database.
-	 *
-	 * @param WPInv_Item $item Item object.
-	 *
-	 */
-	public function read( &$item ) {
-
-		$item->set_defaults();
-		$item_object = get_post( $item->get_id() );
-
-		if ( ! $item->get_id() || ! $item_object || $item_object->post_type != 'wpi_item' ) {
-			$item->last_error = __( 'Invalid item.', 'invoicing' );
-			$item->set_id( 0 );
-			return false;
-		}
-
-		$item->set_props(
-			array(
-				'parent_id'     => $item_object->post_parent,
-				'date_created'  => 0 < $item_object->post_date ? $item_object->post_date : null,
-				'date_modified' => 0 < $item_object->post_modified ? $item_object->post_modified : null,
-				'status'        => $item_object->post_status,
-				'name'          => $item_object->post_title,
-				'description'   => $item_object->post_excerpt,
-				'author'        => $item_object->post_author,
-			)
-		);
-
-		$this->read_object_data( $item, $item_object );
-		$item->read_meta_data();
-		$item->set_object_read( true );
-		do_action( 'getpaid_read_item', $item );
-
-	}
-
-	/**
-	 * Method to update an item in the database.
-	 *
-	 * @param WPInv_Item $item Item object.
-	 */
-	public function update( &$item ) {
-		$item->save_meta_data();
-		$item->set_version( WPINV_VERSION );
-
-		if ( null === $item->get_date_created( 'edit' ) ) {
-			$item->set_date_created(  current_time('mysql') );
-		}
-
-		// Grab the current status so we can compare.
-		$previous_status = get_post_status( $item->get_id() );
-
-		$changes = $item->get_changes();
-
-		// Only update the post when the post data changes.
-		if ( array_intersect( array( 'date_created', 'date_modified', 'status', 'parent_id', 'post_excerpt', 'name', 'author' ), array_keys( $changes ) ) ) {
-			$post_data = array(
-				'post_date'         => $item->get_date_created( 'edit' ),
-				'post_status'       => $item->get_status( 'edit' ),
-				'post_parent'       => $item->get_parent_id( 'edit' ),
-				'post_excerpt'      => $item->get_description( 'edit' ),
-				'post_modified'     => $item->get_date_modified( 'edit' ),
-				'post_title'        => $item->get_name( 'edit' ),
-				'post_author'       => $item->get_author( 'edit' ),
-			);
-
-			/**
-			 * When updating this object, to prevent infinite loops, use $wpdb
-			 * to update data, since wp_update_post spawns more calls to the
-			 * save_post action.
-			 *
-			 * This ensures hooks are fired by either WP itself (admin screen save),
-			 * or an update purely from CRUD.
-			 */
-			if ( doing_action( 'save_post' ) ) {
-				$GLOBALS['wpdb']->update( $GLOBALS['wpdb']->posts, $post_data, array( 'ID' => $item->get_id() ) );
-				clean_post_cache( $item->get_id() );
-			} else {
-				wp_update_post( array_merge( array( 'ID' => $item->get_id() ), $post_data ) );
-			}
-			$item->read_meta_data( true ); // Refresh internal meta data, in case things were hooked into `save_post` or another WP hook.
-		}
-		$this->update_post_meta( $item );
-		$item->apply_changes();
-		$this->clear_caches( $item );
-
-		// Fire a hook depending on the status - this should be considered a creation if it was previously draft status.
-		$new_status = $item->get_status( 'edit' );
-
-		if ( $new_status !== $previous_status && in_array( $previous_status, array( 'new', 'auto-draft', 'draft' ), true ) ) {
-			do_action( 'getpaid_new_item', $item );
-		} else {
-			do_action( 'getpaid_update_item', $item );
-		}
-
-	}
-
-	/*
+        return false;
+    }
+
+    /**
+     * Method to read an item from the database.
+     *
+     * @param WPInv_Item $item Item object.
+     *
+     */
+    public function read( &$item ) {
+
+        $item->set_defaults();
+        $item_object = get_post( $item->get_id() );
+
+        if ( ! $item->get_id() || ! $item_object || $item_object->post_type != 'wpi_item' ) {
+            $item->last_error = __( 'Invalid item.', 'invoicing' );
+            $item->set_id( 0 );
+            return false;
+        }
+
+        $item->set_props(
+            array(
+                'parent_id'     => $item_object->post_parent,
+                'date_created'  => 0 < $item_object->post_date ? $item_object->post_date : null,
+                'date_modified' => 0 < $item_object->post_modified ? $item_object->post_modified : null,
+                'status'        => $item_object->post_status,
+                'name'          => $item_object->post_title,
+                'description'   => $item_object->post_excerpt,
+                'author'        => $item_object->post_author,
+            )
+        );
+
+        $this->read_object_data( $item, $item_object );
+        $item->read_meta_data();
+        $item->set_object_read( true );
+        do_action( 'getpaid_read_item', $item );
+
+    }
+
+    /**
+     * Method to update an item in the database.
+     *
+     * @param WPInv_Item $item Item object.
+     */
+    public function update( &$item ) {
+        $item->save_meta_data();
+        $item->set_version( WPINV_VERSION );
+
+        if ( null === $item->get_date_created( 'edit' ) ) {
+            $item->set_date_created(  current_time('mysql') );
+        }
+
+        // Grab the current status so we can compare.
+        $previous_status = get_post_status( $item->get_id() );
+
+        $changes = $item->get_changes();
+
+        // Only update the post when the post data changes.
+        if ( array_intersect( array( 'date_created', 'date_modified', 'status', 'parent_id', 'post_excerpt', 'name', 'author' ), array_keys( $changes ) ) ) {
+            $post_data = array(
+                'post_date'         => $item->get_date_created( 'edit' ),
+                'post_status'       => $item->get_status( 'edit' ),
+                'post_parent'       => $item->get_parent_id( 'edit' ),
+                'post_excerpt'      => $item->get_description( 'edit' ),
+                'post_modified'     => $item->get_date_modified( 'edit' ),
+                'post_title'        => $item->get_name( 'edit' ),
+                'post_author'       => $item->get_author( 'edit' ),
+            );
+
+            /**
+             * When updating this object, to prevent infinite loops, use $wpdb
+             * to update data, since wp_update_post spawns more calls to the
+             * save_post action.
+             *
+             * This ensures hooks are fired by either WP itself (admin screen save),
+             * or an update purely from CRUD.
+             */
+            if ( doing_action( 'save_post' ) ) {
+                $GLOBALS['wpdb']->update( $GLOBALS['wpdb']->posts, $post_data, array( 'ID' => $item->get_id() ) );
+                clean_post_cache( $item->get_id() );
+            } else {
+                wp_update_post( array_merge( array( 'ID' => $item->get_id() ), $post_data ) );
+            }
+            $item->read_meta_data( true ); // Refresh internal meta data, in case things were hooked into `save_post` or another WP hook.
+        }
+        $this->update_post_meta( $item );
+        $item->apply_changes();
+        $this->clear_caches( $item );
+
+        // Fire a hook depending on the status - this should be considered a creation if it was previously draft status.
+        $new_status = $item->get_status( 'edit' );
+
+        if ( $new_status !== $previous_status && in_array( $previous_status, array( 'new', 'auto-draft', 'draft' ), true ) ) {
+            do_action( 'getpaid_new_item', $item );
+        } else {
+            do_action( 'getpaid_update_item', $item );
+        }
+
+    }
+
+    /*
 	|--------------------------------------------------------------------------
 	| Additional Methods
 	|--------------------------------------------------------------------------
 	*/
 
-	/**
-	 * Helper method that updates all the post meta for an item based on it's settings in the WPInv_Item class.
-	 *
-	 * @param WPInv_Item $item WPInv_Item object.
-	 * @since 1.0.19
-	 */
-	protected function update_post_meta( &$item ) {
+    /**
+     * Helper method that updates all the post meta for an item based on it's settings in the WPInv_Item class.
+     *
+     * @param WPInv_Item $item WPInv_Item object.
+     * @since 1.0.19
+     */
+    protected function update_post_meta( &$item ) {
 
-		// Ensure that we have a custom id.
+        // Ensure that we have a custom id.
         if ( ! $item->get_custom_id() ) {
             $item->set_custom_id( $item->get_id() );
-		}
+        }
 
-		parent::update_post_meta( $item );
-	}
+        parent::update_post_meta( $item );
+    }
 
 }

Spacing +51 added lines, -51 removed lines

@@ -3,7 +3,7 @@ 
  * GetPaid_Item_Data_Store class file.
  *
  */
-if ( ! defined( 'ABSPATH' ) ) {
+if (!defined('ABSPATH')) {
 	exit;
 }
 
@@ -80,39 +80,39 @@ 
 	 *
 	 * @param WPInv_Item $item Item object.
 	 */
-	public function create( &$item ) {
-		$item->set_version( WPINV_VERSION );
-		$item->set_date_created( current_time('mysql') );
+	public function create(&$item) {
+		$item->set_version(WPINV_VERSION);
+		$item->set_date_created(current_time('mysql'));
 
 		// Create a new post.
 		$id = wp_insert_post(
 			apply_filters(
 				'getpaid_new_item_data',
 				array(
-					'post_date'     => $item->get_date_created( 'edit' ),
+					'post_date'     => $item->get_date_created('edit'),
 					'post_type'     => 'wpi_item',
-					'post_status'   => $this->get_post_status( $item ),
+					'post_status'   => $this->get_post_status($item),
 					'ping_status'   => 'closed',
-					'post_author'   => $item->get_author( 'edit' ),
-					'post_title'    => $item->get_name( 'edit' ),
+					'post_author'   => $item->get_author('edit'),
+					'post_title'    => $item->get_name('edit'),
 					'post_parent'   => 0,
-					'post_excerpt'  => $item->get_description( 'edit' ),
+					'post_excerpt'  => $item->get_description('edit'),
 				)
 			),
 			true
 		);
 
-		if ( $id && ! is_wp_error( $id ) ) {
-			$item->set_id( $id );
-			$this->update_post_meta( $item );
+		if ($id && !is_wp_error($id)) {
+			$item->set_id($id);
+			$this->update_post_meta($item);
 			$item->save_meta_data();
 			$item->apply_changes();
-			$this->clear_caches( $item );
-			do_action( 'getpaid_new_item', $item );
+			$this->clear_caches($item);
+			do_action('getpaid_new_item', $item);
 			return true;
 		}
 
-		if ( is_wp_error( $id ) ) {
+		if (is_wp_error($id)) {
 			$item->last_error = $id->get_error_message();
 		}
 		
@@ -125,14 +125,14 @@ 
 	 * @param WPInv_Item $item Item object.
 	 *
 	 */
-	public function read( &$item ) {
+	public function read(&$item) {
 
 		$item->set_defaults();
-		$item_object = get_post( $item->get_id() );
+		$item_object = get_post($item->get_id());
 
-		if ( ! $item->get_id() || ! $item_object || $item_object->post_type != 'wpi_item' ) {
-			$item->last_error = __( 'Invalid item.', 'invoicing' );
-			$item->set_id( 0 );
+		if (!$item->get_id() || !$item_object || $item_object->post_type != 'wpi_item') {
+			$item->last_error = __('Invalid item.', 'invoicing');
+			$item->set_id(0);
 			return false;
 		}
 
@@ -148,10 +148,10 @@ 
 			)
 		);
 
-		$this->read_object_data( $item, $item_object );
+		$this->read_object_data($item, $item_object);
 		$item->read_meta_data();
-		$item->set_object_read( true );
-		do_action( 'getpaid_read_item', $item );
+		$item->set_object_read(true);
+		do_action('getpaid_read_item', $item);
 
 	}
 
@@ -160,29 +160,29 @@ 
 	 *
 	 * @param WPInv_Item $item Item object.
 	 */
-	public function update( &$item ) {
+	public function update(&$item) {
 		$item->save_meta_data();
-		$item->set_version( WPINV_VERSION );
+		$item->set_version(WPINV_VERSION);
 
-		if ( null === $item->get_date_created( 'edit' ) ) {
-			$item->set_date_created(  current_time('mysql') );
+		if (null === $item->get_date_created('edit')) {
+			$item->set_date_created(current_time('mysql'));
 		}
 
 		// Grab the current status so we can compare.
-		$previous_status = get_post_status( $item->get_id() );
+		$previous_status = get_post_status($item->get_id());
 
 		$changes = $item->get_changes();
 
 		// Only update the post when the post data changes.
-		if ( array_intersect( array( 'date_created', 'date_modified', 'status', 'parent_id', 'post_excerpt', 'name', 'author' ), array_keys( $changes ) ) ) {
+		if (array_intersect(array('date_created', 'date_modified', 'status', 'parent_id', 'post_excerpt', 'name', 'author'), array_keys($changes))) {
 			$post_data = array(
-				'post_date'         => $item->get_date_created( 'edit' ),
-				'post_status'       => $item->get_status( 'edit' ),
-				'post_parent'       => $item->get_parent_id( 'edit' ),
-				'post_excerpt'      => $item->get_description( 'edit' ),
-				'post_modified'     => $item->get_date_modified( 'edit' ),
-				'post_title'        => $item->get_name( 'edit' ),
-				'post_author'       => $item->get_author( 'edit' ),
+				'post_date'         => $item->get_date_created('edit'),
+				'post_status'       => $item->get_status('edit'),
+				'post_parent'       => $item->get_parent_id('edit'),
+				'post_excerpt'      => $item->get_description('edit'),
+				'post_modified'     => $item->get_date_modified('edit'),
+				'post_title'        => $item->get_name('edit'),
+				'post_author'       => $item->get_author('edit'),
 			);
 
 			/**
@@ -193,25 +193,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' => $item->get_id() ) );
-				clean_post_cache( $item->get_id() );
+			if (doing_action('save_post')) {
+				$GLOBALS['wpdb']->update($GLOBALS['wpdb']->posts, $post_data, array('ID' => $item->get_id()));
+				clean_post_cache($item->get_id());
 			} else {
-				wp_update_post( array_merge( array( 'ID' => $item->get_id() ), $post_data ) );
+				wp_update_post(array_merge(array('ID' => $item->get_id()), $post_data));
 			}
-			$item->read_meta_data( true ); // Refresh internal meta data, in case things were hooked into `save_post` or another WP hook.
+			$item->read_meta_data(true); // Refresh internal meta data, in case things were hooked into `save_post` or another WP hook.
 		}
-		$this->update_post_meta( $item );
+		$this->update_post_meta($item);
 		$item->apply_changes();
-		$this->clear_caches( $item );
+		$this->clear_caches($item);
 
 		// Fire a hook depending on the status - this should be considered a creation if it was previously draft status.
-		$new_status = $item->get_status( 'edit' );
+		$new_status = $item->get_status('edit');
 
-		if ( $new_status !== $previous_status && in_array( $previous_status, array( 'new', 'auto-draft', 'draft' ), true ) ) {
-			do_action( 'getpaid_new_item', $item );
+		if ($new_status !== $previous_status && in_array($previous_status, array('new', 'auto-draft', 'draft'), true)) {
+			do_action('getpaid_new_item', $item);
 		} else {
-			do_action( 'getpaid_update_item', $item );
+			do_action('getpaid_update_item', $item);
 		}
 
 	}
@@ -228,14 +228,14 @@ 
 	 * @param WPInv_Item $item WPInv_Item object.
 	 * @since 1.0.19
 	 */
-	protected function update_post_meta( &$item ) {
+	protected function update_post_meta(&$item) {
 
 		// Ensure that we have a custom id.
-        if ( ! $item->get_custom_id() ) {
-            $item->set_custom_id( $item->get_id() );
+        if (!$item->get_custom_id()) {
+            $item->set_custom_id($item->get_id());
 		}
 
-		parent::update_post_meta( $item );
+		parent::update_post_meta($item);
 	}
 
 }

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

Indentation +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;
 	}