AyeCode / invoicing

includes/class-wpinv-db.php

Indentation +232 added lines, -232 removed lines

@@ -5,237 +5,237 @@
 
 abstract class Wpinv_DB {
 
-	/**
-	 * The name of our database table
-	 *
-	 * @access  public
-	 * @since   1.0.0
-	 */
-	public $table_name;
-
-	/**
-	 * The version of our database table
-	 *
-	 * @access  public
-	 * @since   1.0.0
-	 */
-	public $version;
-
-	/**
-	 * The name of the primary column
-	 *
-	 * @access  public
-	 * @since   1.0.0
-	 */
-	public $primary_key;
-
-	/**
-	 * Get things started
-	 *
-	 * @access  public
-	 * @since   1.0.0
-	 */
-	public function __construct() {}
-
-	/**
-	 * Whitelist of columns
-	 *
-	 * @access  public
-	 * @since   1.0.0
-	 * @return  array
-	 */
-	public function get_columns() {
-		return array();
-	}
-
-	/**
-	 * Default column values
-	 *
-	 * @access  public
-	 * @since   1.0.0
-	 * @return  array
-	 */
-	public function get_column_defaults() {
-		return array();
-	}
-
-	/**
-	 * Retrieve a row by the primary key
-	 *
-	 * @access  public
-	 * @since   1.0.0
-	 * @return  object
-	 */
-	public function get( $row_id ) {
-		global $wpdb;
-		return $wpdb->get_row( $wpdb->prepare( "SELECT * FROM $this->table_name WHERE $this->primary_key = %s LIMIT 1;", $row_id ) );
-	}
-
-	/**
-	 * Retrieve a row by a specific column / value
-	 *
-	 * @access  public
-	 * @since   1.0.0
-	 * @return  object
-	 */
-	public function get_by( $column, $row_id ) {
-		global $wpdb;
-		$column = esc_sql( $column );
-		return $wpdb->get_row( $wpdb->prepare( "SELECT * FROM $this->table_name WHERE $column = %s LIMIT 1;", $row_id ) );
-	}
-
-	/**
-	 * Retrieve a specific column's value by the primary key
-	 *
-	 * @access  public
-	 * @since   1.0.0
-	 * @return  string
-	 */
-	public function get_column( $column, $row_id ) {
-		global $wpdb;
-		$column = esc_sql( $column );
-		return $wpdb->get_var( $wpdb->prepare( "SELECT $column FROM $this->table_name WHERE $this->primary_key = %s LIMIT 1;", $row_id ) );
-	}
-
-	/**
-	 * Retrieve a specific column's value by the the specified column / value
-	 *
-	 * @access  public
-	 * @since   1.0.0
-	 * @return  string
-	 */
-	public function get_column_by( $column, $column_where, $column_value ) {
-		global $wpdb;
-		$column_where = esc_sql( $column_where );
-		$column       = esc_sql( $column );
-		return $wpdb->get_var( $wpdb->prepare( "SELECT $column FROM $this->table_name WHERE $column_where = %s LIMIT 1;", $column_value ) );
-	}
-
-	/**
-	 * Insert a new row
-	 *
-	 * @access  public
-	 * @since   1.0.0
-	 * @return  int
-	 */
-	public function insert( $data, $type = '' ) {
-		global $wpdb;
-
-		// Set default values
-		$data = wp_parse_args( $data, $this->get_column_defaults() );
-
-		do_action( 'wpinv_pre_insert_' . $type, $data );
-
-		// Initialise column format array
-		$column_formats = $this->get_columns();
-
-		// Force fields to lower case
-		$data = array_change_key_case( $data );
-
-		// White list columns
-		$data = array_intersect_key( $data, $column_formats );
-
-		// Reorder $column_formats to match the order of columns given in $data
-		$data_keys = array_keys( $data );
-		$column_formats = array_merge( array_flip( $data_keys ), $column_formats );
-
-		$wpdb->insert( $this->table_name, $data, $column_formats );
-		$wpdb_insert_id = $wpdb->insert_id;
-
-		do_action( 'wpinv_post_insert_' . $type, $wpdb_insert_id, $data );
-
-		return $wpdb_insert_id;
-	}
-
-	/**
-	 * Update a row
-	 *
-	 * @access  public
-	 * @since   1.0.0
-	 * @return  bool
-	 */
-	public function update( $row_id, $data = array(), $where = '' ) {
-
-		global $wpdb;
-
-		// Row ID must be positive integer
-		$row_id = absint( $row_id );
-
-		if( empty( $row_id ) ) {
-			return false;
-		}
-
-		if( empty( $where ) ) {
-			$where = $this->primary_key;
-		}
-
-		// Initialise column format array
-		$column_formats = $this->get_columns();
-
-		// Force fields to lower case
-		$data = array_change_key_case( $data );
-
-		// White list columns
-		$data = array_intersect_key( $data, $column_formats );
-
-		// Reorder $column_formats to match the order of columns given in $data
-		$data_keys = array_keys( $data );
-		$column_formats = array_merge( array_flip( $data_keys ), $column_formats );
-
-		if ( false === $wpdb->update( $this->table_name, $data, array( $where => $row_id ), $column_formats ) ) {
-			return false;
-		}
-
-		return true;
-	}
-
-	/**
-	 * Delete a row identified by the primary key
-	 *
-	 * @access  public
-	 * @since   1.0.0
-	 * @return  bool
-	 */
-	public function delete( $row_id = 0 ) {
-
-		global $wpdb;
-
-		// Row ID must be positive integer
-		$row_id = absint( $row_id );
-
-		if( empty( $row_id ) ) {
-			return false;
-		}
-
-		if ( false === $wpdb->query( $wpdb->prepare( "DELETE FROM $this->table_name WHERE $this->primary_key = %d", $row_id ) ) ) {
-			return false;
-		}
-
-		return true;
-	}
-
-	/**
-	 * Check if the given table exists
-	 *
-	 * @since  2.4
-	 * @param  string $table The table name
-	 * @return bool          If the table name exists
-	 */
-	public function table_exists( $table ) {
-		global $wpdb;
-		$table = sanitize_text_field( $table );
-
-		return $wpdb->get_var( $wpdb->prepare( "SHOW TABLES LIKE '%s'", $table ) ) === $table;
-	}
-
-	/**
-	 * Check if the table was ever installed
-	 *
-	 * @since  2.4
-	 * @return bool Returns if the customers table was installed and upgrade routine run
-	 */
-	public function installed() {
-		return $this->table_exists( $this->table_name );
-	}
+    /**
+     * The name of our database table
+     *
+     * @access  public
+     * @since   1.0.0
+     */
+    public $table_name;
+
+    /**
+     * The version of our database table
+     *
+     * @access  public
+     * @since   1.0.0
+     */
+    public $version;
+
+    /**
+     * The name of the primary column
+     *
+     * @access  public
+     * @since   1.0.0
+     */
+    public $primary_key;
+
+    /**
+     * Get things started
+     *
+     * @access  public
+     * @since   1.0.0
+     */
+    public function __construct() {}
+
+    /**
+     * Whitelist of columns
+     *
+     * @access  public
+     * @since   1.0.0
+     * @return  array
+     */
+    public function get_columns() {
+        return array();
+    }
+
+    /**
+     * Default column values
+     *
+     * @access  public
+     * @since   1.0.0
+     * @return  array
+     */
+    public function get_column_defaults() {
+        return array();
+    }
+
+    /**
+     * Retrieve a row by the primary key
+     *
+     * @access  public
+     * @since   1.0.0
+     * @return  object
+     */
+    public function get( $row_id ) {
+        global $wpdb;
+        return $wpdb->get_row( $wpdb->prepare( "SELECT * FROM $this->table_name WHERE $this->primary_key = %s LIMIT 1;", $row_id ) );
+    }
+
+    /**
+     * Retrieve a row by a specific column / value
+     *
+     * @access  public
+     * @since   1.0.0
+     * @return  object
+     */
+    public function get_by( $column, $row_id ) {
+        global $wpdb;
+        $column = esc_sql( $column );
+        return $wpdb->get_row( $wpdb->prepare( "SELECT * FROM $this->table_name WHERE $column = %s LIMIT 1;", $row_id ) );
+    }
+
+    /**
+     * Retrieve a specific column's value by the primary key
+     *
+     * @access  public
+     * @since   1.0.0
+     * @return  string
+     */
+    public function get_column( $column, $row_id ) {
+        global $wpdb;
+        $column = esc_sql( $column );
+        return $wpdb->get_var( $wpdb->prepare( "SELECT $column FROM $this->table_name WHERE $this->primary_key = %s LIMIT 1;", $row_id ) );
+    }
+
+    /**
+     * Retrieve a specific column's value by the the specified column / value
+     *
+     * @access  public
+     * @since   1.0.0
+     * @return  string
+     */
+    public function get_column_by( $column, $column_where, $column_value ) {
+        global $wpdb;
+        $column_where = esc_sql( $column_where );
+        $column       = esc_sql( $column );
+        return $wpdb->get_var( $wpdb->prepare( "SELECT $column FROM $this->table_name WHERE $column_where = %s LIMIT 1;", $column_value ) );
+    }
+
+    /**
+     * Insert a new row
+     *
+     * @access  public
+     * @since   1.0.0
+     * @return  int
+     */
+    public function insert( $data, $type = '' ) {
+        global $wpdb;
+
+        // Set default values
+        $data = wp_parse_args( $data, $this->get_column_defaults() );
+
+        do_action( 'wpinv_pre_insert_' . $type, $data );
+
+        // Initialise column format array
+        $column_formats = $this->get_columns();
+
+        // Force fields to lower case
+        $data = array_change_key_case( $data );
+
+        // White list columns
+        $data = array_intersect_key( $data, $column_formats );
+
+        // Reorder $column_formats to match the order of columns given in $data
+        $data_keys = array_keys( $data );
+        $column_formats = array_merge( array_flip( $data_keys ), $column_formats );
+
+        $wpdb->insert( $this->table_name, $data, $column_formats );
+        $wpdb_insert_id = $wpdb->insert_id;
+
+        do_action( 'wpinv_post_insert_' . $type, $wpdb_insert_id, $data );
+
+        return $wpdb_insert_id;
+    }
+
+    /**
+     * Update a row
+     *
+     * @access  public
+     * @since   1.0.0
+     * @return  bool
+     */
+    public function update( $row_id, $data = array(), $where = '' ) {
+
+        global $wpdb;
+
+        // Row ID must be positive integer
+        $row_id = absint( $row_id );
+
+        if( empty( $row_id ) ) {
+            return false;
+        }
+
+        if( empty( $where ) ) {
+            $where = $this->primary_key;
+        }
+
+        // Initialise column format array
+        $column_formats = $this->get_columns();
+
+        // Force fields to lower case
+        $data = array_change_key_case( $data );
+
+        // White list columns
+        $data = array_intersect_key( $data, $column_formats );
+
+        // Reorder $column_formats to match the order of columns given in $data
+        $data_keys = array_keys( $data );
+        $column_formats = array_merge( array_flip( $data_keys ), $column_formats );
+
+        if ( false === $wpdb->update( $this->table_name, $data, array( $where => $row_id ), $column_formats ) ) {
+            return false;
+        }
+
+        return true;
+    }
+
+    /**
+     * Delete a row identified by the primary key
+     *
+     * @access  public
+     * @since   1.0.0
+     * @return  bool
+     */
+    public function delete( $row_id = 0 ) {
+
+        global $wpdb;
+
+        // Row ID must be positive integer
+        $row_id = absint( $row_id );
+
+        if( empty( $row_id ) ) {
+            return false;
+        }
+
+        if ( false === $wpdb->query( $wpdb->prepare( "DELETE FROM $this->table_name WHERE $this->primary_key = %d", $row_id ) ) ) {
+            return false;
+        }
+
+        return true;
+    }
+
+    /**
+     * Check if the given table exists
+     *
+     * @since  2.4
+     * @param  string $table The table name
+     * @return bool          If the table name exists
+     */
+    public function table_exists( $table ) {
+        global $wpdb;
+        $table = sanitize_text_field( $table );
+
+        return $wpdb->get_var( $wpdb->prepare( "SHOW TABLES LIKE '%s'", $table ) ) === $table;
+    }
+
+    /**
+     * Check if the table was ever installed
+     *
+     * @since  2.4
+     * @return bool Returns if the customers table was installed and upgrade routine run
+     */
+    public function installed() {
+        return $this->table_exists( $this->table_name );
+    }
 
 }

includes/wpinv-general-functions.php

Indentation +54 added lines, -54 removed lines

@@ -30,36 +30,36 @@ 
 }
 
 function wpinv_can_checkout() {
-	$can_checkout = true; // Always true for now
+    $can_checkout = true; // Always true for now
 
-	return (bool) apply_filters( 'wpinv_can_checkout', $can_checkout );
+    return (bool) apply_filters( 'wpinv_can_checkout', $can_checkout );
 }
 
 function wpinv_get_success_page_uri() {
-	$page_id = wpinv_get_option( 'success_page', 0 );
-	$page_id = absint( $page_id );
+    $page_id = wpinv_get_option( 'success_page', 0 );
+    $page_id = absint( $page_id );
 
-	return apply_filters( 'wpinv_get_success_page_uri', get_permalink( $page_id ) );
+    return apply_filters( 'wpinv_get_success_page_uri', get_permalink( $page_id ) );
 }
 
 function wpinv_get_history_page_uri() {
-	$page_id = wpinv_get_option( 'invoice_history_page', 0 );
-	$page_id = absint( $page_id );
+    $page_id = wpinv_get_option( 'invoice_history_page', 0 );
+    $page_id = absint( $page_id );
 
-	return apply_filters( 'wpinv_get_history_page_uri', get_permalink( $page_id ) );
+    return apply_filters( 'wpinv_get_history_page_uri', get_permalink( $page_id ) );
 }
 
 function wpinv_is_success_page() {
-	$is_success_page = wpinv_get_option( 'success_page', false );
-	$is_success_page = isset( $is_success_page ) ? is_page( $is_success_page ) : false;
+    $is_success_page = wpinv_get_option( 'success_page', false );
+    $is_success_page = isset( $is_success_page ) ? is_page( $is_success_page ) : false;
 
-	return apply_filters( 'wpinv_is_success_page', $is_success_page );
+    return apply_filters( 'wpinv_is_success_page', $is_success_page );
 }
 
 function wpinv_is_invoice_history_page() {
-	$ret = wpinv_get_option( 'invoice_history_page', false );
-	$ret = $ret ? is_page( $ret ) : false;
-	return apply_filters( 'wpinv_is_invoice_history_page', $ret );
+    $ret = wpinv_get_option( 'invoice_history_page', false );
+    $ret = $ret ? is_page( $ret ) : false;
+    return apply_filters( 'wpinv_is_invoice_history_page', $ret );
 }
 
 function wpinv_is_subscriptions_history_page() {
@@ -69,7 +69,7 @@ 
 }
 
 function wpinv_send_to_success_page( $args = null ) {
-	$redirect = wpinv_get_success_page_uri();
+    $redirect = wpinv_get_success_page_uri();
     
     if ( !empty( $args ) ) {
         // Check for backward compatibility
@@ -89,7 +89,7 @@ 
 }
 
 function wpinv_send_to_failed_page( $args = null ) {
-	$redirect = wpinv_get_failed_transaction_uri();
+    $redirect = wpinv_get_failed_transaction_uri();
     
     if ( !empty( $args ) ) {
         // Check for backward compatibility
@@ -109,72 +109,72 @@ 
 }
 
 function wpinv_get_checkout_uri( $args = array() ) {
-	$uri = wpinv_get_option( 'checkout_page', false );
-	$uri = isset( $uri ) ? get_permalink( $uri ) : NULL;
+    $uri = wpinv_get_option( 'checkout_page', false );
+    $uri = isset( $uri ) ? get_permalink( $uri ) : NULL;
 
-	if ( !empty( $args ) ) {
-		// Check for backward compatibility
-		if ( is_string( $args ) )
-			$args = str_replace( '?', '', $args );
+    if ( !empty( $args ) ) {
+        // Check for backward compatibility
+        if ( is_string( $args ) )
+            $args = str_replace( '?', '', $args );
 
-		$args = wp_parse_args( $args );
+        $args = wp_parse_args( $args );
 
-		$uri = add_query_arg( $args, $uri );
-	}
+        $uri = add_query_arg( $args, $uri );
+    }
 
-	$scheme = defined( 'FORCE_SSL_ADMIN' ) && FORCE_SSL_ADMIN ? 'https' : 'admin';
+    $scheme = defined( 'FORCE_SSL_ADMIN' ) && FORCE_SSL_ADMIN ? 'https' : 'admin';
 
-	$ajax_url = admin_url( 'admin-ajax.php', $scheme );
+    $ajax_url = admin_url( 'admin-ajax.php', $scheme );
 
-	if ( ( ! preg_match( '/^https/', $uri ) && preg_match( '/^https/', $ajax_url ) ) || wpinv_is_ssl_enforced() ) {
-		$uri = preg_replace( '/^http:/', 'https:', $uri );
-	}
+    if ( ( ! preg_match( '/^https/', $uri ) && preg_match( '/^https/', $ajax_url ) ) || wpinv_is_ssl_enforced() ) {
+        $uri = preg_replace( '/^http:/', 'https:', $uri );
+    }
 
-	return apply_filters( 'wpinv_get_checkout_uri', $uri );
+    return apply_filters( 'wpinv_get_checkout_uri', $uri );
 }
 
 function wpinv_send_back_to_checkout( $args = array() ) {
-	$redirect = wpinv_get_checkout_uri();
+    $redirect = wpinv_get_checkout_uri();
 
-	if ( ! empty( $args ) ) {
-		// Check for backward compatibility
-		if ( is_string( $args ) )
-			$args = str_replace( '?', '', $args );
+    if ( ! empty( $args ) ) {
+        // Check for backward compatibility
+        if ( is_string( $args ) )
+            $args = str_replace( '?', '', $args );
 
-		$args = wp_parse_args( $args );
+        $args = wp_parse_args( $args );
 
-		$redirect = add_query_arg( $args, $redirect );
-	}
+        $redirect = add_query_arg( $args, $redirect );
+    }
 
-	wp_redirect( apply_filters( 'wpinv_send_back_to_checkout', $redirect, $args ) );
-	exit;
+    wp_redirect( apply_filters( 'wpinv_send_back_to_checkout', $redirect, $args ) );
+    exit;
 }
 
 function wpinv_get_success_page_url( $query_string = null ) {
-	$success_page = wpinv_get_option( 'success_page', 0 );
-	$success_page = get_permalink( $success_page );
+    $success_page = wpinv_get_option( 'success_page', 0 );
+    $success_page = get_permalink( $success_page );
 
-	if ( $query_string )
-		$success_page .= $query_string;
+    if ( $query_string )
+        $success_page .= $query_string;
 
-	return apply_filters( 'wpinv_success_page_url', $success_page );
+    return apply_filters( 'wpinv_success_page_url', $success_page );
 }
 
 function wpinv_get_failed_transaction_uri( $extras = false ) {
-	$uri = wpinv_get_option( 'failure_page', '' );
-	$uri = ! empty( $uri ) ? trailingslashit( get_permalink( $uri ) ) : home_url();
+    $uri = wpinv_get_option( 'failure_page', '' );
+    $uri = ! empty( $uri ) ? trailingslashit( get_permalink( $uri ) ) : home_url();
 
-	if ( $extras )
-		$uri .= $extras;
+    if ( $extras )
+        $uri .= $extras;
 
-	return apply_filters( 'wpinv_get_failed_transaction_uri', $uri );
+    return apply_filters( 'wpinv_get_failed_transaction_uri', $uri );
 }
 
 function wpinv_is_failed_transaction_page() {
-	$ret = wpinv_get_option( 'failure_page', false );
-	$ret = isset( $ret ) ? is_page( $ret ) : false;
+    $ret = wpinv_get_option( 'failure_page', false );
+    $ret = isset( $ret ) ? is_page( $ret ) : false;
 
-	return apply_filters( 'wpinv_is_failure_page', $ret );
+    return apply_filters( 'wpinv_is_failure_page', $ret );
 }
 
 function wpinv_transaction_query( $type = 'start' ) {

includes/class-wpinv-shortcodes.php

Doc Comments +3 added lines

@@ -22,6 +22,9 @@
         add_shortcode( 'wpinv_messages', __CLASS__ . '::messages' );
     }
 
+    /**
+     * @param string[] $function
+     */
     public static function shortcode_wrapper( $function, $atts = array(), $content = null, $wrapper = array( 'class' => 'wpi-g', 'before' => null, 'after' => null ) ) {
         ob_start();
 

includes/class-wpinv-invoice.php

Doc Comments +24 added lines

@@ -83,6 +83,9 @@ 
         return $value;
     }
 
+    /**
+     * @param string $key
+     */
     public function set( $key, $value ) {
         $ignore = array( 'items', 'cart_details', 'fees', '_ID' );
 
@@ -921,6 +924,9 @@ 
         return $removed;
     }
 
+    /**
+     * @param string $key
+     */
     public function remove_fee_by( $key, $value, $global = false ) {
         $allowed_fee_keys = apply_filters( 'wpinv_fee_keys', array(
             'index', 'label', 'amount', 'type',
@@ -1381,6 +1387,9 @@ 
         return apply_filters( 'wpinv_get_invoice_final_total', $final_total, $this, $currency );
     }
     
+    /**
+     * @return boolean
+     */
     public function get_discounts( $array = false ) {
         $discounts = $this->discounts;
         if ( $array && $discounts ) {
@@ -1389,6 +1398,9 @@ 
         return apply_filters( 'wpinv_payment_discounts', $discounts, $this->ID, $this, $array );
     }
     
+    /**
+     * @return string
+     */
     public function get_discount( $currency = false, $dash = false ) {
         if ( !empty( $this->discounts ) ) {
             global $ajax_cart_details;
@@ -1491,10 +1503,16 @@ 
         return apply_filters( 'wpinv_user_full_name', $this->full_name, $this->ID, $this );
     }
     
+    /**
+     * @return string
+     */
     public function get_user_info() {
         return apply_filters( 'wpinv_user_info', $this->user_info, $this->ID, $this );
     }
     
+    /**
+     * @return string
+     */
     public function get_email() {
         return apply_filters( 'wpinv_user_email', $this->email, $this->ID, $this );
     }
@@ -1537,6 +1555,9 @@ 
         return apply_filters( 'wpinv_currency_code', $this->currency, $this->ID, $this );
     }
     
+    /**
+     * @return string
+     */
     public function get_created_date() {
         return apply_filters( 'wpinv_created_date', $this->date, $this->ID, $this );
     }
@@ -1555,6 +1576,9 @@ 
         return apply_filters( 'wpinv_completed_date', $this->completed_date, $this->ID, $this );
     }
     
+    /**
+     * @return string
+     */
     public function get_invoice_date( $formatted = true ) {
         $date_completed = $this->completed_date;
         $invoice_date   = $date_completed != '' && $date_completed != '0000-00-00 00:00:00' ? $date_completed : '';

includes/wpinv-helper-functions.php

Doc Comments +30 added lines, -1 removed lines

@@ -31,6 +31,9 @@ 
     return apply_filters( 'wpinv_get_ip', $ip );
 }
 
+/**
+ * @return string
+ */
 function wpinv_get_user_agent() {
     if ( ! empty( $_SERVER['HTTP_USER_AGENT'] ) ) {
         $user_agent = sanitize_text_field( $_SERVER['HTTP_USER_AGENT'] );
@@ -41,6 +44,9 @@ 
     return apply_filters( 'wpinv_get_user_agent', $user_agent );
 }
 
+/**
+ * @param integer $decimals
+ */
 function wpinv_sanitize_amount( $amount, $decimals = NULL ) {
     $is_negative   = false;
     $thousands_sep = wpinv_thousands_separator();
@@ -79,6 +85,9 @@ 
 }
 add_filter( 'wpinv_sanitize_amount_decimals', 'wpinv_currency_decimal_filter', 10, 1 );
 
+/**
+ * @param integer $decimals
+ */
 function wpinv_round_amount( $amount, $decimals = NULL ) {
     if ( $decimals === NULL ) {
         $decimals = wpinv_decimals();
@@ -298,6 +307,9 @@ 
     return apply_filters( 'wpinv_currency_symbol', $currency_symbol, $currency );
 }
 
+/**
+ * @return string
+ */
 function wpinv_currency_position() {
     $position = wpinv_get_option( 'currency_position', 'left' );
     
@@ -556,6 +568,9 @@ 
     return $price;
 }
 
+/**
+ * @return string
+ */
 function wpinv_format_amount( $amount, $decimals = NULL, $calculate = false ) {
     $thousands_sep = wpinv_thousands_separator();
     $decimal_sep   = wpinv_decimal_separator();
@@ -606,6 +621,9 @@ 
     return apply_filters( 'wpinv_sanitize_key', $key, $raw_key );
 }
 
+/**
+ * @return string
+ */
 function wpinv_get_file_extension( $str ) {
     $parts = explode( '.', $str );
     return end( $parts );
@@ -810,6 +828,9 @@ 
     return strlen( $str );
 }
 
+/**
+ * @param string $str
+ */
 function wpinv_utf8_strtolower( $str, $encoding = 'UTF-8' ) {
     if ( function_exists( 'mb_strtolower' ) ) {
         return mb_strtolower( $str, $encoding );
@@ -818,6 +839,9 @@ 
     return strtolower( $str );
 }
 
+/**
+ * @param string $str
+ */
 function wpinv_utf8_strtoupper( $str, $encoding = 'UTF-8' ) {
     if ( function_exists( 'mb_strtoupper' ) ) {
         return mb_strtoupper( $str, $encoding );
@@ -895,7 +919,7 @@ 
  *
  * @param string $str The string being decoded.
  * @param string $encoding The encoding parameter is the character encoding. Default "UTF-8".
- * @return string The width of string.
+ * @return integer The width of string.
  */
 function wpinv_utf8_strwidth( $str, $encoding = 'UTF-8' ) {
     if ( function_exists( 'mb_strwidth' ) ) {
@@ -946,6 +970,11 @@ 
     return $period;
 }
 
+/**
+ * @param integer $calendar
+ * @param string $month
+ * @param string $year
+ */
 function wpinv_cal_days_in_month( $calendar, $month, $year ) {
     if ( function_exists( 'cal_days_in_month' ) ) {
         return cal_days_in_month( $calendar, $month, $year );

includes/wpinv-invoice-functions.php

Doc Comments +12 added lines

@@ -488,6 +488,9 @@ 
     return $invoice->get_description();
 }
 
+/**
+ * @return string
+ */
 function wpinv_get_invoice_currency_code( $invoice_id = 0 ) {
     $invoice = new WPInv_Invoice( $invoice_id );
     return $invoice->get_currency();
@@ -521,6 +524,9 @@ 
     return $invoice->get_gateway_title();
 }
 
+/**
+ * @return string
+ */
 function wpinv_get_payment_transaction_id( $invoice_id ) {
     $invoice = new WPInv_Invoice( $invoice_id );
     
@@ -616,6 +622,9 @@ 
     return $invoice->get_total( $currency );
 }
 
+/**
+ * @return string
+ */
 function wpinv_get_date_created( $invoice_id = 0, $format = '' ) {
     $invoice = new WPInv_Invoice( $invoice_id );
 
@@ -626,6 +635,9 @@ 
     return $date_created;
 }
 
+/**
+ * @return string
+ */
 function wpinv_get_invoice_date( $invoice_id = 0, $format = '', $default = true ) {
     $invoice = new WPInv_Invoice( $invoice_id );
     

includes/wpinv-subscription.php

Doc Comments +5 added lines, -5 removed lines

@@ -370,7 +370,7 @@ 
 	 * Retrieves the transaction ID from the subscription
 	 *
 	 * @since  1.0.0
-	 * @return bool
+	 * @return string
 	 */
 	public function get_transaction_id() {
 
@@ -392,7 +392,7 @@ 
 	 * Stores the transaction ID for the subscription purchase
 	 *
 	 * @since  1.0.0.4
-	 * @return bool
+	 * @return boolean|null
 	 */
 	public function set_transaction_id( $txn_id = '' ) {
 		$this->update( array( 'transaction_id' => $txn_id ) );
@@ -403,7 +403,7 @@ 
 	 * Renews a subscription
 	 *
 	 * @since  1.0.0
-	 * @return bool
+	 * @return boolean|null
 	 */
 	public function renew() {
 
@@ -492,7 +492,7 @@ 
 	 *
 	 * @since  1.0.0
 	 * @param  $check_expiration bool True if expiration date should be checked with merchant processor before expiring
-	 * @return void
+	 * @return false|null
 	 */
 	public function expire( $check_expiration = false ) {
 
@@ -744,7 +744,7 @@ 
 	 * Retrieves the subscription status
 	 *
 	 * @since  1.0.0
-	 * @return int
+	 * @return string
 	 */
 	public function get_status() {
 

Indentation +454 added lines, -454 removed lines

@@ -2,7 +2,7 @@ 
 
 // Exit if accessed directly
 if ( ! defined( 'ABSPATH' ) ) {
-	exit;
+    exit;
 }
 
 
@@ -13,183 +13,183 @@ 
  */
 class WPInv_Subscription {
 
-	private $subs_db;
+    private $subs_db;
+
+    public $id                = 0;
+    public $customer_id       = 0;
+    public $period            = '';
+    public $initial_amount    = '';
+    public $recurring_amount  = '';
+    public $bill_times        = 0;
+    public $transaction_id    = '';
+    public $parent_payment_id = 0;
+    public $product_id        = 0;
+    public $created           = '0000-00-00 00:00:00';
+    public $expiration        = '0000-00-00 00:00:00';
+    public $trial_period      = '';
+    public $status            = 'pending';
+    public $profile_id        = '';
+    public $gateway           = '';
+    public $customer;
 
-	public $id                = 0;
-	public $customer_id       = 0;
-	public $period            = '';
-	public $initial_amount    = '';
-	public $recurring_amount  = '';
-	public $bill_times        = 0;
-	public $transaction_id    = '';
-	public $parent_payment_id = 0;
-	public $product_id        = 0;
-	public $created           = '0000-00-00 00:00:00';
-	public $expiration        = '0000-00-00 00:00:00';
-	public $trial_period      = '';
-	public $status            = 'pending';
-	public $profile_id        = '';
-	public $gateway           = '';
-	public $customer;
-
-	/**
-	 * Get us started
-	 *
-	 * @since  1.0.0
-	 * @return void
-	 */
-	function __construct( $_id_or_object = 0, $_by_profile_id = false ) {
+    /**
+     * Get us started
+     *
+     * @since  1.0.0
+     * @return void
+     */
+    function __construct( $_id_or_object = 0, $_by_profile_id = false ) {
 
-		$this->subs_db = new WPInv_Subscriptions_DB;
+        $this->subs_db = new WPInv_Subscriptions_DB;
 
-		if( $_by_profile_id ) {
+        if( $_by_profile_id ) {
 
-			$_sub = $this->subs_db->get_by( 'profile_id', $_id_or_object );
+            $_sub = $this->subs_db->get_by( 'profile_id', $_id_or_object );
 
-			if( empty( $_sub ) ) {
-				return false;
-			}
+            if( empty( $_sub ) ) {
+                return false;
+            }
 
-			$_id_or_object = $_sub;
+            $_id_or_object = $_sub;
 
-		}
+        }
 
-		return $this->setup_subscription( $_id_or_object );
-	}
+        return $this->setup_subscription( $_id_or_object );
+    }
 
-	/**
-	 * Setup the subscription object
-	 *
-	 * @since  1.0.0
-	 * @return void
-	 */
-	private function setup_subscription( $id_or_object = 0 ) {
+    /**
+     * Setup the subscription object
+     *
+     * @since  1.0.0
+     * @return void
+     */
+    private function setup_subscription( $id_or_object = 0 ) {
 
-		if( empty( $id_or_object ) ) {
-			return false;
-		}
+        if( empty( $id_or_object ) ) {
+            return false;
+        }
 
-		if( is_numeric( $id_or_object ) ) {
+        if( is_numeric( $id_or_object ) ) {
 
-			$sub = $this->subs_db->get( $id_or_object );
+            $sub = $this->subs_db->get( $id_or_object );
 
-		} elseif( is_object( $id_or_object ) ) {
+        } elseif( is_object( $id_or_object ) ) {
 
-			$sub = $id_or_object;
+            $sub = $id_or_object;
 
-		}
+        }
 
-		if( empty( $sub ) ) {
-			return false;
-		}
+        if( empty( $sub ) ) {
+            return false;
+        }
 
-		foreach( $sub as $key => $value ) {
-			$this->$key = $value;
-		}
+        foreach( $sub as $key => $value ) {
+            $this->$key = $value;
+        }
 
-		$this->customer = get_userdata( $this->customer_id );
-		$this->gateway  = wpinv_get_payment_gateway( $this->parent_payment_id );
+        $this->customer = get_userdata( $this->customer_id );
+        $this->gateway  = wpinv_get_payment_gateway( $this->parent_payment_id );
 
-		do_action( 'wpinv_recurring_setup_subscription', $this );
+        do_action( 'wpinv_recurring_setup_subscription', $this );
 
-		return $this;
-	}
+        return $this;
+    }
 
-	/**
-	 * Magic __get function to dispatch a call to retrieve a private property
-	 *
-	 * @since 1.0.0
-	 */
-	public function __get( $key ) {
+    /**
+     * Magic __get function to dispatch a call to retrieve a private property
+     *
+     * @since 1.0.0
+     */
+    public function __get( $key ) {
 
-		if( method_exists( $this, 'get_' . $key ) ) {
+        if( method_exists( $this, 'get_' . $key ) ) {
 
-			return call_user_func( array( $this, 'get_' . $key ) );
+            return call_user_func( array( $this, 'get_' . $key ) );
 
-		} else {
+        } else {
 
-			return new WP_Error( 'wpinv-subscription-invalid-property', sprintf( __( 'Can\'t get property %s', 'invoicing' ), $key ) );
+            return new WP_Error( 'wpinv-subscription-invalid-property', sprintf( __( 'Can\'t get property %s', 'invoicing' ), $key ) );
 
-		}
+        }
 
-	}
+    }
 
-	/**
-	 * Creates a subscription
-	 *
-	 * @since  1.0.0
-	 * @param  array  $data Array of attributes for a subscription
-	 * @return mixed  false if data isn't passed and class not instantiated for creation
-	 */
-	public function create( $data = array() ) {
+    /**
+     * Creates a subscription
+     *
+     * @since  1.0.0
+     * @param  array  $data Array of attributes for a subscription
+     * @return mixed  false if data isn't passed and class not instantiated for creation
+     */
+    public function create( $data = array() ) {
 
-		if ( $this->id != 0 ) {
-			return false;
-		}
+        if ( $this->id != 0 ) {
+            return false;
+        }
 
-		$defaults = array(
-			'customer_id'       => 0,
-			'frequency'         => '',
-			'period'            => '',
-			'initial_amount'    => '',
-			'recurring_amount'  => '',
-			'bill_times'        => 0,
-			'parent_payment_id' => 0,
-			'product_id'        => 0,
-			'created'           => '',
-			'expiration'        => '',
-			'status'            => '',
-			'profile_id'        => '',
-		);
+        $defaults = array(
+            'customer_id'       => 0,
+            'frequency'         => '',
+            'period'            => '',
+            'initial_amount'    => '',
+            'recurring_amount'  => '',
+            'bill_times'        => 0,
+            'parent_payment_id' => 0,
+            'product_id'        => 0,
+            'created'           => '',
+            'expiration'        => '',
+            'status'            => '',
+            'profile_id'        => '',
+        );
 
-		$args = wp_parse_args( $data, $defaults );
+        $args = wp_parse_args( $data, $defaults );
 
-		if( $args['expiration'] && strtotime( 'NOW', current_time( 'timestamp' ) ) > strtotime( $args['expiration'], current_time( 'timestamp' ) ) ) {
+        if( $args['expiration'] && strtotime( 'NOW', current_time( 'timestamp' ) ) > strtotime( $args['expiration'], current_time( 'timestamp' ) ) ) {
 
-			if( 'active' == $args['status'] || 'trialling' == $args['status'] ) {
+            if( 'active' == $args['status'] || 'trialling' == $args['status'] ) {
 
-				// Force an active subscription to expired if expiration date is in the past
-				$args['status'] = 'expired';
+                // Force an active subscription to expired if expiration date is in the past
+                $args['status'] = 'expired';
 
-			}
-		}
+            }
+        }
 
-		do_action( 'wpinv_subscription_pre_create', $args );
+        do_action( 'wpinv_subscription_pre_create', $args );
 
-		$id = $this->subs_db->insert( $args, 'subscription' );
+        $id = $this->subs_db->insert( $args, 'subscription' );
 
-		do_action( 'wpinv_subscription_post_create', $id, $args );
+        do_action( 'wpinv_subscription_post_create', $id, $args );
 
-		return $this->setup_subscription( $id );
+        return $this->setup_subscription( $id );
 
-	}
+    }
 
-	/**
-	 * Updates a subscription
-	 *
-	 * @since  1.0.0
-	 * @param  array $args Array of fields to update
-	 * @return bool
-	 */
-	public function update( $args = array() ) {
+    /**
+     * Updates a subscription
+     *
+     * @since  1.0.0
+     * @param  array $args Array of fields to update
+     * @return bool
+     */
+    public function update( $args = array() ) {
 
-		$ret = $this->subs_db->update( $this->id, $args );
+        $ret = $this->subs_db->update( $this->id, $args );
 
-		do_action( 'wpinv_recurring_update_subscription', $this->id, $args, $this );
+        do_action( 'wpinv_recurring_update_subscription', $this->id, $args, $this );
 
-		return $ret;
+        return $ret;
 
-	}
+    }
 
-	/**
-	 * Delete the subscription
-	 *
-	 * @since  1.0.0
-	 * @return bool
-	 */
-	public function delete() {
-		return $this->subs_db->delete( $this->id );
-	}
+    /**
+     * Delete the subscription
+     *
+     * @since  1.0.0
+     * @return bool
+     */
+    public function delete() {
+        return $this->subs_db->delete( $this->id );
+    }
 
     /**
      * Retrieves the parent payment ID
@@ -366,185 +366,185 @@ 
         return false;
     }
 
-	/**
-	 * Retrieves the transaction ID from the subscription
-	 *
-	 * @since  1.0.0
-	 * @return bool
-	 */
-	public function get_transaction_id() {
+    /**
+     * Retrieves the transaction ID from the subscription
+     *
+     * @since  1.0.0
+     * @return bool
+     */
+    public function get_transaction_id() {
 
-		if( empty( $this->transaction_id ) ) {
+        if( empty( $this->transaction_id ) ) {
 
-			$txn_id = wpinv_get_payment_transaction_id( $this->parent_payment_id );
+            $txn_id = wpinv_get_payment_transaction_id( $this->parent_payment_id );
 
-			if( ! empty( $txn_id ) && (int) $this->parent_payment_id !== (int) $txn_id ) {
-				$this->set_transaction_id( $txn_id );
-			}
+            if( ! empty( $txn_id ) && (int) $this->parent_payment_id !== (int) $txn_id ) {
+                $this->set_transaction_id( $txn_id );
+            }
 
-		}
+        }
 
-		return $this->transaction_id;
+        return $this->transaction_id;
 
-	}
+    }
 
-	/**
-	 * Stores the transaction ID for the subscription purchase
-	 *
-	 * @since  1.0.0.4
-	 * @return bool
-	 */
-	public function set_transaction_id( $txn_id = '' ) {
-		$this->update( array( 'transaction_id' => $txn_id ) );
-		$this->transaction_id = $txn_id;
-	}
+    /**
+     * Stores the transaction ID for the subscription purchase
+     *
+     * @since  1.0.0.4
+     * @return bool
+     */
+    public function set_transaction_id( $txn_id = '' ) {
+        $this->update( array( 'transaction_id' => $txn_id ) );
+        $this->transaction_id = $txn_id;
+    }
 
-	/**
-	 * Renews a subscription
-	 *
-	 * @since  1.0.0
-	 * @return bool
-	 */
-	public function renew() {
+    /**
+     * Renews a subscription
+     *
+     * @since  1.0.0
+     * @return bool
+     */
+    public function renew() {
 
-		$expires = $this->get_expiration_time();
+        $expires = $this->get_expiration_time();
 
 
-		// Determine what date to use as the start for the new expiration calculation
-		if( $expires > current_time( 'timestamp' ) && $this->is_active() ) {
+        // Determine what date to use as the start for the new expiration calculation
+        if( $expires > current_time( 'timestamp' ) && $this->is_active() ) {
 
-			$base_date  = $expires;
+            $base_date  = $expires;
 
-		} else {
+        } else {
 
-			$base_date  = current_time( 'timestamp' );
+            $base_date  = current_time( 'timestamp' );
 
-		}
+        }
 
-		$last_day = wpinv_cal_days_in_month( CAL_GREGORIAN, date( 'n', $base_date ), date( 'Y', $base_date ) );
+        $last_day = wpinv_cal_days_in_month( CAL_GREGORIAN, date( 'n', $base_date ), date( 'Y', $base_date ) );
 
 
-		$frequency = isset($this->frequency) ? $this->frequency : 1;
-		$expiration = date( 'Y-m-d H:i:s', strtotime( '+' . $frequency . ' ' . $this->period  . ' 23:59:59', $base_date ) );
+        $frequency = isset($this->frequency) ? $this->frequency : 1;
+        $expiration = date( 'Y-m-d H:i:s', strtotime( '+' . $frequency . ' ' . $this->period  . ' 23:59:59', $base_date ) );
 
-		if( date( 'j', $base_date ) == $last_day && 'day' != $this->period ) {
-			$expiration = date( 'Y-m-d H:i:s', strtotime( $expiration . ' +2 days' ) );
-		}
+        if( date( 'j', $base_date ) == $last_day && 'day' != $this->period ) {
+            $expiration = date( 'Y-m-d H:i:s', strtotime( $expiration . ' +2 days' ) );
+        }
 
-		$expiration  = apply_filters( 'wpinv_subscription_renewal_expiration', $expiration, $this->id, $this );
+        $expiration  = apply_filters( 'wpinv_subscription_renewal_expiration', $expiration, $this->id, $this );
 
-		do_action( 'wpinv_subscription_pre_renew', $this->id, $expiration, $this );
+        do_action( 'wpinv_subscription_pre_renew', $this->id, $expiration, $this );
 
-		$this->status = 'active';
-		$times_billed = $this->get_times_billed();
+        $this->status = 'active';
+        $times_billed = $this->get_times_billed();
 
-		// Complete subscription if applicable
-		if ( $this->bill_times > 0 && $times_billed >= $this->bill_times ) {
-			$this->complete();
-			$this->status = 'completed';
-		}
+        // Complete subscription if applicable
+        if ( $this->bill_times > 0 && $times_billed >= $this->bill_times ) {
+            $this->complete();
+            $this->status = 'completed';
+        }
 
-		$args = array(
-			'expiration' => $expiration,
-			'status'     => $this->status,
-		);
+        $args = array(
+            'expiration' => $expiration,
+            'status'     => $this->status,
+        );
 
         $this->subs_db->update( $this->id, $args );
 
-		do_action( 'wpinv_subscription_post_renew', $this->id, $expiration, $this );
-		do_action( 'wpinv_recurring_set_subscription_status', $this->id, $this->status, $this );
+        do_action( 'wpinv_subscription_post_renew', $this->id, $expiration, $this );
+        do_action( 'wpinv_recurring_set_subscription_status', $this->id, $this->status, $this );
 
-	}
+    }
 
-	/**
-	 * Marks a subscription as completed
-	 *
-	 * Subscription is completed when the number of payments matches the billing_times field
-	 *
-	 * @since  1.0.0
-	 * @return void
-	 */
-	public function complete() {
+    /**
+     * Marks a subscription as completed
+     *
+     * Subscription is completed when the number of payments matches the billing_times field
+     *
+     * @since  1.0.0
+     * @return void
+     */
+    public function complete() {
 
-		// Only mark a subscription as complete if it's not already cancelled.
-		if ( 'cancelled' === $this->status ) {
-			return;
-		}
+        // Only mark a subscription as complete if it's not already cancelled.
+        if ( 'cancelled' === $this->status ) {
+            return;
+        }
 
-		$args = array(
-			'status' => 'completed'
-		);
+        $args = array(
+            'status' => 'completed'
+        );
 
-		if( $this->subs_db->update( $this->id, $args ) ) {
+        if( $this->subs_db->update( $this->id, $args ) ) {
 
-			$this->status = 'completed';
+            $this->status = 'completed';
 
-			do_action( 'wpinv_subscription_completed', $this->id, $this );
+            do_action( 'wpinv_subscription_completed', $this->id, $this );
 
-		}
+        }
 
-	}
+    }
 
-	/**
-	 * Marks a subscription as expired
-	 *
-	 * Subscription is completed when the billing times is reached
-	 *
-	 * @since  1.0.0
-	 * @param  $check_expiration bool True if expiration date should be checked with merchant processor before expiring
-	 * @return void
-	 */
-	public function expire( $check_expiration = false ) {
+    /**
+     * Marks a subscription as expired
+     *
+     * Subscription is completed when the billing times is reached
+     *
+     * @since  1.0.0
+     * @param  $check_expiration bool True if expiration date should be checked with merchant processor before expiring
+     * @return void
+     */
+    public function expire( $check_expiration = false ) {
 
-		$expiration = $this->expiration;
+        $expiration = $this->expiration;
 
-		if( $check_expiration ) {
+        if( $check_expiration ) {
 
-			// check_expiration() updates $this->expiration so compare to $expiration above
+            // check_expiration() updates $this->expiration so compare to $expiration above
 
-			if( $expiration < $this->get_expiration() && current_time( 'timestamp' ) < $this->get_expiration_time() ) {
+            if( $expiration < $this->get_expiration() && current_time( 'timestamp' ) < $this->get_expiration_time() ) {
 
-				return false; // Do not mark as expired since real expiration date is in the future
-			}
+                return false; // Do not mark as expired since real expiration date is in the future
+            }
 
-		}
+        }
 
-		$args = array(
-			'status' => 'expired'
-		);
+        $args = array(
+            'status' => 'expired'
+        );
 
-		if( $this->subs_db->update( $this->id, $args ) ) {
+        if( $this->subs_db->update( $this->id, $args ) ) {
 
-			$this->status = 'expired';
+            $this->status = 'expired';
 
-			do_action( 'wpinv_subscription_expired', $this->id, $this );
+            do_action( 'wpinv_subscription_expired', $this->id, $this );
 
-		}
+        }
 
-	}
+    }
 
-	/**
-	 * Marks a subscription as failing
-	 *
-	 * @since  2.4.2
-	 * @return void
-	 */
-	public function failing() {
+    /**
+     * Marks a subscription as failing
+     *
+     * @since  2.4.2
+     * @return void
+     */
+    public function failing() {
 
-		$args = array(
-			'status' => 'failing'
-		);
+        $args = array(
+            'status' => 'failing'
+        );
 
-		if( $this->subs_db->update( $this->id, $args ) ) {
+        if( $this->subs_db->update( $this->id, $args ) ) {
 
-			$this->status = 'failing';
+            $this->status = 'failing';
 
-			do_action( 'wpinv_subscription_failing', $this->id, $this );
+            do_action( 'wpinv_subscription_failing', $this->id, $this );
 
 
-		}
+        }
 
-	}
+    }
 
     /**
      * Marks a subscription as cancelled
@@ -578,22 +578,22 @@ 
         }
     }
 
-	/**
-	 * Determines if subscription can be cancelled
-	 *
-	 * This method is filtered by payment gateways in order to return true on subscriptions
-	 * that can be cancelled with a profile ID through the merchant processor
-	 *
-	 * @since  1.0.0
-	 * @return bool
-	 */
-	public function can_cancel() {
+    /**
+     * Determines if subscription can be cancelled
+     *
+     * This method is filtered by payment gateways in order to return true on subscriptions
+     * that can be cancelled with a profile ID through the merchant processor
+     *
+     * @since  1.0.0
+     * @return bool
+     */
+    public function can_cancel() {
         $ret = false;
-	    if( $this->gateway === 'manual' || in_array( $this->status, $this->get_cancellable_statuses() ) ) {
+        if( $this->gateway === 'manual' || in_array( $this->status, $this->get_cancellable_statuses() ) ) {
             $ret = true;
         }
-		return apply_filters( 'wpinv_subscription_can_cancel', $ret, $this );
-	}
+        return apply_filters( 'wpinv_subscription_can_cancel', $ret, $this );
+    }
 
     /**
      * Returns an array of subscription statuses that can be cancelled
@@ -606,197 +606,197 @@ 
         return apply_filters( 'wpinv_recurring_cancellable_statuses', array( 'active', 'trialling', 'failing' ) );
     }
 
-	/**
-	 * Retrieves the URL to cancel subscription
-	 *
-	 * @since  1.0.0
-	 * @return string
-	 */
-	public function get_cancel_url() {
+    /**
+     * Retrieves the URL to cancel subscription
+     *
+     * @since  1.0.0
+     * @return string
+     */
+    public function get_cancel_url() {
 
-		$url = wp_nonce_url( add_query_arg( array( 'wpinv_action' => 'cancel_subscription', 'sub_id' => $this->id ) ), 'wpinv-recurring-cancel' );
+        $url = wp_nonce_url( add_query_arg( array( 'wpinv_action' => 'cancel_subscription', 'sub_id' => $this->id ) ), 'wpinv-recurring-cancel' );
 
-		return apply_filters( 'wpinv_subscription_cancel_url', $url, $this );
-	}
+        return apply_filters( 'wpinv_subscription_cancel_url', $url, $this );
+    }
 
-	/**
-	 * Determines if subscription can be manually renewed
-	 *
-	 * This method is filtered by payment gateways in order to return true on subscriptions
-	 * that can be renewed manually
-	 *
-	 * @since  2.5
-	 * @return bool
-	 */
-	public function can_renew() {
+    /**
+     * Determines if subscription can be manually renewed
+     *
+     * This method is filtered by payment gateways in order to return true on subscriptions
+     * that can be renewed manually
+     *
+     * @since  2.5
+     * @return bool
+     */
+    public function can_renew() {
 
-		return apply_filters( 'wpinv_subscription_can_renew', true, $this );
-	}
-
-	/**
-	 * Retrieves the URL to renew a subscription
-	 *
-	 * @since  2.5
-	 * @return string
-	 */
-	public function get_renew_url() {
-
-		$url = wp_nonce_url( add_query_arg( array( 'wpinv_action' => 'renew_subscription', 'sub_id' => $this->id ) ), 'wpinv-recurring-renew' );
-
-		return apply_filters( 'wpinv_subscription_renew_url', $url, $this );
-	}
-
-	/**
-	 * Determines if subscription can have their payment method updated
-	 *
-	 * @since  1.0.0
-	 * @return bool
-	 */
-	public function can_update() {
-		return apply_filters( 'wpinv_subscription_can_update', false, $this );
-	}
-
-	/**
-	 * Retrieves the URL to update subscription
-	 *
-	 * @since  1.0.0
-	 * @return void
-	 */
-	public function get_update_url() {
-
-		$url = add_query_arg( array( 'action' => 'update', 'subscription_id' => $this->id ) );
-
-		return apply_filters( 'wpinv_subscription_update_url', $url, $this );
-	}
-
-	/**
-	 * Determines if subscription is active
-	 *
-	 * @since  1.0.0
-	 * @return void
-	 */
-	public function is_active() {
-
-		$ret = false;
-
-		if( ! $this->is_expired() && ( $this->status == 'active' || $this->status == 'cancelled' || $this->status == 'trialling' ) ) {
-			$ret = true;
-		}
-
-		return apply_filters( 'wpinv_subscription_is_active', $ret, $this->id, $this );
-
-	}
-
-	/**
-	 * Determines if subscription is expired
-	 *
-	 * @since  1.0.0
-	 * @return void
-	 */
-	public function is_expired() {
-
-		$ret = false;
-
-		if ( $this->status == 'expired' ) {
-
-			$ret = true;
-
-		} elseif( 'active' === $this->status || 'cancelled' === $this->status || $this->status == 'trialling'  ) {
-
-			$ret        = false;
-			$expiration = $this->get_expiration_time();
-
-			if( $expiration && strtotime( 'NOW', current_time( 'timestamp' ) ) > $expiration ) {
-				$ret = true;
-
-				if ( 'active' === $this->status || $this->status == 'trialling'  ) {
-					$this->expire();
-				}
-			}
-
-		}
-
-		return apply_filters( 'wpinv_subscription_is_expired', $ret, $this->id, $this );
-
-	}
-
-	/**
-	 * Retrieves the expiration date
-	 *
-	 * @since  1.0.0
-	 * @return string
-	 */
-	public function get_expiration() {
-		return $this->expiration;
-	}
-
-	/**
-	 * Retrieves the expiration date in a timestamp
-	 *
-	 * @since  1.0.0
-	 * @return int
-	 */
-	public function get_expiration_time() {
-		return strtotime( $this->expiration, current_time( 'timestamp' ) );
-	}
-
-	/**
-	 * Retrieves the subscription status
-	 *
-	 * @since  1.0.0
-	 * @return int
-	 */
-	public function get_status() {
-
-		// Monitor for page load delays on pages with large subscription lists (IE: Subscriptions table in admin)
-		$this->is_expired();
-		return $this->status;
-	}
-
-	/**
-	 * Retrieves the subscription status label
-	 *
-	 * @since  1.0.0
-	 * @return int
-	 */
-	public function get_status_label() {
-
-		switch( $this->get_status() ) {
-			case 'active' :
-				$status = __( 'Active', 'invoicing' );
-				break;
-
-			case 'cancelled' :
-				$status = __( 'Cancelled', 'invoicing' );
-				break;
-
-			case 'expired' :
-				$status = __( 'Expired', 'invoicing' );
-				break;
-
-			case 'pending' :
-				$status = __( 'Pending', 'invoicing' );
-				break;
-
-			case 'failing' :
-				$status = __( 'Failing', 'invoicing' );
-				break;
-
-			case 'trialling' :
-				$status = __( 'Trialling', 'invoicing' );
-				break;
-
-			case 'completed' :
-				$status = __( 'Completed', 'invoicing' );
-				break;
-
-			default:
-				$status = ucfirst( $this->get_status() );
-				break;
-		}
-
-		return $status;
-	}
+        return apply_filters( 'wpinv_subscription_can_renew', true, $this );
+    }
+
+    /**
+     * Retrieves the URL to renew a subscription
+     *
+     * @since  2.5
+     * @return string
+     */
+    public function get_renew_url() {
+
+        $url = wp_nonce_url( add_query_arg( array( 'wpinv_action' => 'renew_subscription', 'sub_id' => $this->id ) ), 'wpinv-recurring-renew' );
+
+        return apply_filters( 'wpinv_subscription_renew_url', $url, $this );
+    }
+
+    /**
+     * Determines if subscription can have their payment method updated
+     *
+     * @since  1.0.0
+     * @return bool
+     */
+    public function can_update() {
+        return apply_filters( 'wpinv_subscription_can_update', false, $this );
+    }
+
+    /**
+     * Retrieves the URL to update subscription
+     *
+     * @since  1.0.0
+     * @return void
+     */
+    public function get_update_url() {
+
+        $url = add_query_arg( array( 'action' => 'update', 'subscription_id' => $this->id ) );
+
+        return apply_filters( 'wpinv_subscription_update_url', $url, $this );
+    }
+
+    /**
+     * Determines if subscription is active
+     *
+     * @since  1.0.0
+     * @return void
+     */
+    public function is_active() {
+
+        $ret = false;
+
+        if( ! $this->is_expired() && ( $this->status == 'active' || $this->status == 'cancelled' || $this->status == 'trialling' ) ) {
+            $ret = true;
+        }
+
+        return apply_filters( 'wpinv_subscription_is_active', $ret, $this->id, $this );
+
+    }
+
+    /**
+     * Determines if subscription is expired
+     *
+     * @since  1.0.0
+     * @return void
+     */
+    public function is_expired() {
+
+        $ret = false;
+
+        if ( $this->status == 'expired' ) {
+
+            $ret = true;
+
+        } elseif( 'active' === $this->status || 'cancelled' === $this->status || $this->status == 'trialling'  ) {
+
+            $ret        = false;
+            $expiration = $this->get_expiration_time();
+
+            if( $expiration && strtotime( 'NOW', current_time( 'timestamp' ) ) > $expiration ) {
+                $ret = true;
+
+                if ( 'active' === $this->status || $this->status == 'trialling'  ) {
+                    $this->expire();
+                }
+            }
+
+        }
+
+        return apply_filters( 'wpinv_subscription_is_expired', $ret, $this->id, $this );
+
+    }
+
+    /**
+     * Retrieves the expiration date
+     *
+     * @since  1.0.0
+     * @return string
+     */
+    public function get_expiration() {
+        return $this->expiration;
+    }
+
+    /**
+     * Retrieves the expiration date in a timestamp
+     *
+     * @since  1.0.0
+     * @return int
+     */
+    public function get_expiration_time() {
+        return strtotime( $this->expiration, current_time( 'timestamp' ) );
+    }
+
+    /**
+     * Retrieves the subscription status
+     *
+     * @since  1.0.0
+     * @return int
+     */
+    public function get_status() {
+
+        // Monitor for page load delays on pages with large subscription lists (IE: Subscriptions table in admin)
+        $this->is_expired();
+        return $this->status;
+    }
+
+    /**
+     * Retrieves the subscription status label
+     *
+     * @since  1.0.0
+     * @return int
+     */
+    public function get_status_label() {
+
+        switch( $this->get_status() ) {
+            case 'active' :
+                $status = __( 'Active', 'invoicing' );
+                break;
+
+            case 'cancelled' :
+                $status = __( 'Cancelled', 'invoicing' );
+                break;
+
+            case 'expired' :
+                $status = __( 'Expired', 'invoicing' );
+                break;
+
+            case 'pending' :
+                $status = __( 'Pending', 'invoicing' );
+                break;
+
+            case 'failing' :
+                $status = __( 'Failing', 'invoicing' );
+                break;
+
+            case 'trialling' :
+                $status = __( 'Trialling', 'invoicing' );
+                break;
+
+            case 'completed' :
+                $status = __( 'Completed', 'invoicing' );
+                break;
+
+            default:
+                $status = ucfirst( $this->get_status() );
+                break;
+        }
+
+        return $status;
+    }
 
     /**
      * Retrieves the subscription status label

includes/gateways/paypal.php

Indentation +255 added lines, -255 removed lines

@@ -218,262 +218,262 @@ 
 add_filter( 'wpinv_paypal_args', 'wpinv_get_paypal_recurring_args', 10, 3 );
 
 function wpinv_process_paypal_ipn() {
-	// Check the request method is POST
-	if ( isset( $_SERVER['REQUEST_METHOD'] ) && $_SERVER['REQUEST_METHOD'] != 'POST' ) {
-		return;
-	}
-
-	// Set initial post data to empty string
-	$post_data = '';
-
-	// Fallback just in case post_max_size is lower than needed
-	if ( ini_get( 'allow_url_fopen' ) ) {
-		$post_data = file_get_contents( 'php://input' );
-	} else {
-		// If allow_url_fopen is not enabled, then make sure that post_max_size is large enough
-		ini_set( 'post_max_size', '12M' );
-	}
-	// Start the encoded data collection with notification command
-	$encoded_data = 'cmd=_notify-validate';
-
-	// Get current arg separator
-	$arg_separator = wpinv_get_php_arg_separator_output();
-
-	// Verify there is a post_data
-	if ( $post_data || strlen( $post_data ) > 0 ) {
-		// Append the data
-		$encoded_data .= $arg_separator.$post_data;
-	} else {
-		// Check if POST is empty
-		if ( empty( $_POST ) ) {
-			// Nothing to do
-			return;
-		} else {
-			// Loop through each POST
-			foreach ( $_POST as $key => $value ) {
-				// Encode the value and append the data
-				$encoded_data .= $arg_separator."$key=" . urlencode( $value );
-			}
-		}
-	}
-
-	// Convert collected post data to an array
-	parse_str( $encoded_data, $encoded_data_array );
-
-	foreach ( $encoded_data_array as $key => $value ) {
-		if ( false !== strpos( $key, 'amp;' ) ) {
-			$new_key = str_replace( '&', '&', $key );
-			$new_key = str_replace( 'amp;', '&' , $new_key );
-
-			unset( $encoded_data_array[ $key ] );
-			$encoded_data_array[ $new_key ] = $value;
-		}
-	}
-
-	// Get the PayPal redirect uri
-	$paypal_redirect = wpinv_get_paypal_redirect( true );
-
-	if ( !wpinv_get_option( 'disable_paypal_verification', false ) ) {
-		// Validate the IPN
-
-		$remote_post_vars      = array(
-			'method'           => 'POST',
-			'timeout'          => 45,
-			'redirection'      => 5,
-			'httpversion'      => '1.1',
-			'blocking'         => true,
-			'headers'          => array(
-				'host'         => 'www.paypal.com',
-				'connection'   => 'close',
-				'content-type' => 'application/x-www-form-urlencoded',
-				'post'         => '/cgi-bin/webscr HTTP/1.1',
-
-			),
-			'sslverify'        => false,
-			'body'             => $encoded_data_array
-		);
-
-		// Get response
-		$api_response = wp_remote_post( wpinv_get_paypal_redirect(), $remote_post_vars );
-
-		if ( is_wp_error( $api_response ) ) {
-			wpinv_record_gateway_error( __( 'IPN Error', 'invoicing' ), sprintf( __( 'Invalid IPN verification response. IPN data: %s', 'invoicing' ), json_encode( $api_response ) ) );
-			return; // Something went wrong
-		}
-
-		if ( $api_response['body'] !== 'VERIFIED' && wpinv_get_option( 'disable_paypal_verification', false ) ) {
-			wpinv_record_gateway_error( __( 'IPN Error', 'invoicing' ), sprintf( __( 'Invalid IPN verification response. IPN data: %s', 'invoicing' ), json_encode( $api_response ) ) );
-			return; // Response not okay
-		}
-	}
-
-	// Check if $post_data_array has been populated
-	if ( !is_array( $encoded_data_array ) && !empty( $encoded_data_array ) )
-		return;
-
-	$defaults = array(
-		'txn_type'       => '',
-		'payment_status' => ''
-	);
-
-	$encoded_data_array = wp_parse_args( $encoded_data_array, $defaults );
-
-	$invoice_id = isset( $encoded_data_array['custom'] ) ? absint( $encoded_data_array['custom'] ) : 0;
+    // Check the request method is POST
+    if ( isset( $_SERVER['REQUEST_METHOD'] ) && $_SERVER['REQUEST_METHOD'] != 'POST' ) {
+        return;
+    }
+
+    // Set initial post data to empty string
+    $post_data = '';
+
+    // Fallback just in case post_max_size is lower than needed
+    if ( ini_get( 'allow_url_fopen' ) ) {
+        $post_data = file_get_contents( 'php://input' );
+    } else {
+        // If allow_url_fopen is not enabled, then make sure that post_max_size is large enough
+        ini_set( 'post_max_size', '12M' );
+    }
+    // Start the encoded data collection with notification command
+    $encoded_data = 'cmd=_notify-validate';
+
+    // Get current arg separator
+    $arg_separator = wpinv_get_php_arg_separator_output();
+
+    // Verify there is a post_data
+    if ( $post_data || strlen( $post_data ) > 0 ) {
+        // Append the data
+        $encoded_data .= $arg_separator.$post_data;
+    } else {
+        // Check if POST is empty
+        if ( empty( $_POST ) ) {
+            // Nothing to do
+            return;
+        } else {
+            // Loop through each POST
+            foreach ( $_POST as $key => $value ) {
+                // Encode the value and append the data
+                $encoded_data .= $arg_separator."$key=" . urlencode( $value );
+            }
+        }
+    }
+
+    // Convert collected post data to an array
+    parse_str( $encoded_data, $encoded_data_array );
+
+    foreach ( $encoded_data_array as $key => $value ) {
+        if ( false !== strpos( $key, 'amp;' ) ) {
+            $new_key = str_replace( '&', '&', $key );
+            $new_key = str_replace( 'amp;', '&' , $new_key );
+
+            unset( $encoded_data_array[ $key ] );
+            $encoded_data_array[ $new_key ] = $value;
+        }
+    }
+
+    // Get the PayPal redirect uri
+    $paypal_redirect = wpinv_get_paypal_redirect( true );
+
+    if ( !wpinv_get_option( 'disable_paypal_verification', false ) ) {
+        // Validate the IPN
+
+        $remote_post_vars      = array(
+            'method'           => 'POST',
+            'timeout'          => 45,
+            'redirection'      => 5,
+            'httpversion'      => '1.1',
+            'blocking'         => true,
+            'headers'          => array(
+                'host'         => 'www.paypal.com',
+                'connection'   => 'close',
+                'content-type' => 'application/x-www-form-urlencoded',
+                'post'         => '/cgi-bin/webscr HTTP/1.1',
+
+            ),
+            'sslverify'        => false,
+            'body'             => $encoded_data_array
+        );
+
+        // Get response
+        $api_response = wp_remote_post( wpinv_get_paypal_redirect(), $remote_post_vars );
+
+        if ( is_wp_error( $api_response ) ) {
+            wpinv_record_gateway_error( __( 'IPN Error', 'invoicing' ), sprintf( __( 'Invalid IPN verification response. IPN data: %s', 'invoicing' ), json_encode( $api_response ) ) );
+            return; // Something went wrong
+        }
+
+        if ( $api_response['body'] !== 'VERIFIED' && wpinv_get_option( 'disable_paypal_verification', false ) ) {
+            wpinv_record_gateway_error( __( 'IPN Error', 'invoicing' ), sprintf( __( 'Invalid IPN verification response. IPN data: %s', 'invoicing' ), json_encode( $api_response ) ) );
+            return; // Response not okay
+        }
+    }
+
+    // Check if $post_data_array has been populated
+    if ( !is_array( $encoded_data_array ) && !empty( $encoded_data_array ) )
+        return;
+
+    $defaults = array(
+        'txn_type'       => '',
+        'payment_status' => ''
+    );
+
+    $encoded_data_array = wp_parse_args( $encoded_data_array, $defaults );
+
+    $invoice_id = isset( $encoded_data_array['custom'] ) ? absint( $encoded_data_array['custom'] ) : 0;
     
-	wpinv_error_log( $encoded_data_array['txn_type'], 'PayPal txn_type', __FILE__, __LINE__ );
-	wpinv_error_log( $encoded_data_array, 'PayPal IPN response', __FILE__, __LINE__ );
-
-	if ( has_action( 'wpinv_paypal_' . $encoded_data_array['txn_type'] ) ) {
-		// Allow PayPal IPN types to be processed separately
-		do_action( 'wpinv_paypal_' . $encoded_data_array['txn_type'], $encoded_data_array, $invoice_id );
-	} else {
-		// Fallback to web accept just in case the txn_type isn't present
-		do_action( 'wpinv_paypal_web_accept', $encoded_data_array, $invoice_id );
-	}
-	exit;
+    wpinv_error_log( $encoded_data_array['txn_type'], 'PayPal txn_type', __FILE__, __LINE__ );
+    wpinv_error_log( $encoded_data_array, 'PayPal IPN response', __FILE__, __LINE__ );
+
+    if ( has_action( 'wpinv_paypal_' . $encoded_data_array['txn_type'] ) ) {
+        // Allow PayPal IPN types to be processed separately
+        do_action( 'wpinv_paypal_' . $encoded_data_array['txn_type'], $encoded_data_array, $invoice_id );
+    } else {
+        // Fallback to web accept just in case the txn_type isn't present
+        do_action( 'wpinv_paypal_web_accept', $encoded_data_array, $invoice_id );
+    }
+    exit;
 }
 add_action( 'wpinv_verify_paypal_ipn', 'wpinv_process_paypal_ipn' );
 
 function wpinv_process_paypal_web_accept_and_cart( $data, $invoice_id ) {
-	if ( $data['txn_type'] != 'web_accept' && $data['txn_type'] != 'cart' && $data['payment_status'] != 'Refunded' ) {
-		return;
-	}
-
-	if( empty( $invoice_id ) ) {
-		return;
-	}
-
-	// Collect payment details
-	$purchase_key   = isset( $data['invoice'] ) ? $data['invoice'] : $data['item_number'];
-	$paypal_amount  = $data['mc_gross'];
-	$payment_status = strtolower( $data['payment_status'] );
-	$currency_code  = strtolower( $data['mc_currency'] );
-	$business_email = isset( $data['business'] ) && is_email( $data['business'] ) ? trim( $data['business'] ) : trim( $data['receiver_email'] );
-	$payment_meta   = wpinv_get_invoice_meta( $invoice_id );
-
-	if ( wpinv_get_payment_gateway( $invoice_id ) != 'paypal' ) {
-		return; // this isn't a PayPal standard IPN
-	}
-
-	// Verify payment recipient
-	if ( strcasecmp( $business_email, trim( wpinv_get_option( 'paypal_email', false ) ) ) != 0 ) {
-		wpinv_record_gateway_error( __( 'IPN Error', 'invoicing' ), sprintf( __( 'Invalid business email in IPN response. IPN data: %s', 'invoicing' ), json_encode( $data ) ), $invoice_id );
-		wpinv_update_payment_status( $invoice_id, 'wpi-failed' );
-		wpinv_insert_payment_note( $invoice_id, __( 'Payment failed due to invalid PayPal business email.', 'invoicing' ), '', '', true );
-		return;
-	}
-
-	// Verify payment currency
-	if ( $currency_code != strtolower( $payment_meta['currency'] ) ) {
-		wpinv_record_gateway_error( __( 'IPN Error', 'invoicing' ), sprintf( __( 'Invalid currency in IPN response. IPN data: %s', 'invoicing' ), json_encode( $data ) ), $invoice_id );
-		wpinv_update_payment_status( $invoice_id, 'wpi-failed' );
-		wpinv_insert_payment_note( $invoice_id, __( 'Payment failed due to invalid currency in PayPal IPN.', 'invoicing' ), '', '', true );
-		return;
-	}
-
-	if ( !wpinv_get_payment_user_email( $invoice_id ) ) {
-		// This runs when a Buy Now purchase was made. It bypasses checkout so no personal info is collected until PayPal
-		// No email associated with purchase, so store from PayPal
-		wpinv_update_invoice_meta( $invoice_id, '_wpinv_email', $data['payer_email'] );
-
-		// Setup and store the customer's details
-		$user_info = array(
-			'user_id'    => '-1',
-			'email'      => sanitize_text_field( $data['payer_email'] ),
-			'first_name' => sanitize_text_field( $data['first_name'] ),
-			'last_name'  => sanitize_text_field( $data['last_name'] ),
-			'discount'   => '',
-		);
-		$user_info['address'] = ! empty( $data['address_street']       ) ? sanitize_text_field( $data['address_street'] )       : false;
-		$user_info['city']    = ! empty( $data['address_city']         ) ? sanitize_text_field( $data['address_city'] )         : false;
-		$user_info['state']   = ! empty( $data['address_state']        ) ? sanitize_text_field( $data['address_state'] )        : false;
-		$user_info['country'] = ! empty( $data['address_country_code'] ) ? sanitize_text_field( $data['address_country_code'] ) : false;
-		$user_info['zip']     = ! empty( $data['address_zip']          ) ? sanitize_text_field( $data['address_zip'] )          : false;
-
-		$payment_meta['user_info'] = $user_info;
-		wpinv_update_invoice_meta( $invoice_id, '_wpinv_payment_meta', $payment_meta );
-	}
-
-	if ( $payment_status == 'refunded' || $payment_status == 'reversed' ) {
-		// Process a refund
-		wpinv_process_paypal_refund( $data, $invoice_id );
-	} else {
-		if ( get_post_status( $invoice_id ) == 'publish' ) {
-			return; // Only paid payments once
-		}
-
-		// Retrieve the total purchase amount (before PayPal)
-		$payment_amount = wpinv_payment_total( $invoice_id );
-
-		if ( number_format( (float) $paypal_amount, 2 ) < number_format( (float) $payment_amount, 2 ) ) {
-			// The prices don't match
-			wpinv_record_gateway_error( __( 'IPN Error', 'invoicing' ), sprintf( __( 'Invalid payment amount in IPN response. IPN data: %s', 'invoicing' ), json_encode( $data ) ), $invoice_id );
-			wpinv_update_payment_status( $invoice_id, 'wpi-failed' );
-			wpinv_insert_payment_note( $invoice_id, __( 'Payment failed due to invalid amount in PayPal IPN.', 'invoicing' ), '', '', true );
-			return;
-		}
-		if ( $purchase_key != wpinv_get_payment_key( $invoice_id ) ) {
-			// Purchase keys don't match
-			wpinv_record_gateway_error( __( 'IPN Error', 'invoicing' ), sprintf( __( 'Invalid purchase key in IPN response. IPN data: %s', 'invoicing' ), json_encode( $data ) ), $invoice_id );
-			wpinv_update_payment_status( $invoice_id, 'wpi-failed' );
-			wpinv_insert_payment_note( $invoice_id, __( 'Payment failed due to invalid purchase key in PayPal IPN.', 'invoicing' ), '', '', true );
-			return;
-		}
-
-		if ( 'complete' == $payment_status || 'completed' == $payment_status || 'processed' == $payment_status || wpinv_is_test_mode( 'paypal' ) ) {
-			wpinv_insert_payment_note( $invoice_id, sprintf( __( 'PayPal Transaction ID: %s', 'invoicing' ) , $data['txn_id'] ), '', '', true );
-			wpinv_set_payment_transaction_id( $invoice_id, $data['txn_id'] );
-			wpinv_update_payment_status( $invoice_id, 'publish' );
-		} else if ( 'pending' == $payment_status && isset( $data['pending_reason'] ) ) {
-			// Look for possible pending reasons, such as an echeck
-			$note = '';
-
-			switch( strtolower( $data['pending_reason'] ) ) {
-				case 'echeck' :
-					$note = __( 'Payment made via eCheck and will clear automatically in 5-8 days', 'invoicing' );
-					break;
+    if ( $data['txn_type'] != 'web_accept' && $data['txn_type'] != 'cart' && $data['payment_status'] != 'Refunded' ) {
+        return;
+    }
+
+    if( empty( $invoice_id ) ) {
+        return;
+    }
+
+    // Collect payment details
+    $purchase_key   = isset( $data['invoice'] ) ? $data['invoice'] : $data['item_number'];
+    $paypal_amount  = $data['mc_gross'];
+    $payment_status = strtolower( $data['payment_status'] );
+    $currency_code  = strtolower( $data['mc_currency'] );
+    $business_email = isset( $data['business'] ) && is_email( $data['business'] ) ? trim( $data['business'] ) : trim( $data['receiver_email'] );
+    $payment_meta   = wpinv_get_invoice_meta( $invoice_id );
+
+    if ( wpinv_get_payment_gateway( $invoice_id ) != 'paypal' ) {
+        return; // this isn't a PayPal standard IPN
+    }
+
+    // Verify payment recipient
+    if ( strcasecmp( $business_email, trim( wpinv_get_option( 'paypal_email', false ) ) ) != 0 ) {
+        wpinv_record_gateway_error( __( 'IPN Error', 'invoicing' ), sprintf( __( 'Invalid business email in IPN response. IPN data: %s', 'invoicing' ), json_encode( $data ) ), $invoice_id );
+        wpinv_update_payment_status( $invoice_id, 'wpi-failed' );
+        wpinv_insert_payment_note( $invoice_id, __( 'Payment failed due to invalid PayPal business email.', 'invoicing' ), '', '', true );
+        return;
+    }
+
+    // Verify payment currency
+    if ( $currency_code != strtolower( $payment_meta['currency'] ) ) {
+        wpinv_record_gateway_error( __( 'IPN Error', 'invoicing' ), sprintf( __( 'Invalid currency in IPN response. IPN data: %s', 'invoicing' ), json_encode( $data ) ), $invoice_id );
+        wpinv_update_payment_status( $invoice_id, 'wpi-failed' );
+        wpinv_insert_payment_note( $invoice_id, __( 'Payment failed due to invalid currency in PayPal IPN.', 'invoicing' ), '', '', true );
+        return;
+    }
+
+    if ( !wpinv_get_payment_user_email( $invoice_id ) ) {
+        // This runs when a Buy Now purchase was made. It bypasses checkout so no personal info is collected until PayPal
+        // No email associated with purchase, so store from PayPal
+        wpinv_update_invoice_meta( $invoice_id, '_wpinv_email', $data['payer_email'] );
+
+        // Setup and store the customer's details
+        $user_info = array(
+            'user_id'    => '-1',
+            'email'      => sanitize_text_field( $data['payer_email'] ),
+            'first_name' => sanitize_text_field( $data['first_name'] ),
+            'last_name'  => sanitize_text_field( $data['last_name'] ),
+            'discount'   => '',
+        );
+        $user_info['address'] = ! empty( $data['address_street']       ) ? sanitize_text_field( $data['address_street'] )       : false;
+        $user_info['city']    = ! empty( $data['address_city']         ) ? sanitize_text_field( $data['address_city'] )         : false;
+        $user_info['state']   = ! empty( $data['address_state']        ) ? sanitize_text_field( $data['address_state'] )        : false;
+        $user_info['country'] = ! empty( $data['address_country_code'] ) ? sanitize_text_field( $data['address_country_code'] ) : false;
+        $user_info['zip']     = ! empty( $data['address_zip']          ) ? sanitize_text_field( $data['address_zip'] )          : false;
+
+        $payment_meta['user_info'] = $user_info;
+        wpinv_update_invoice_meta( $invoice_id, '_wpinv_payment_meta', $payment_meta );
+    }
+
+    if ( $payment_status == 'refunded' || $payment_status == 'reversed' ) {
+        // Process a refund
+        wpinv_process_paypal_refund( $data, $invoice_id );
+    } else {
+        if ( get_post_status( $invoice_id ) == 'publish' ) {
+            return; // Only paid payments once
+        }
+
+        // Retrieve the total purchase amount (before PayPal)
+        $payment_amount = wpinv_payment_total( $invoice_id );
+
+        if ( number_format( (float) $paypal_amount, 2 ) < number_format( (float) $payment_amount, 2 ) ) {
+            // The prices don't match
+            wpinv_record_gateway_error( __( 'IPN Error', 'invoicing' ), sprintf( __( 'Invalid payment amount in IPN response. IPN data: %s', 'invoicing' ), json_encode( $data ) ), $invoice_id );
+            wpinv_update_payment_status( $invoice_id, 'wpi-failed' );
+            wpinv_insert_payment_note( $invoice_id, __( 'Payment failed due to invalid amount in PayPal IPN.', 'invoicing' ), '', '', true );
+            return;
+        }
+        if ( $purchase_key != wpinv_get_payment_key( $invoice_id ) ) {
+            // Purchase keys don't match
+            wpinv_record_gateway_error( __( 'IPN Error', 'invoicing' ), sprintf( __( 'Invalid purchase key in IPN response. IPN data: %s', 'invoicing' ), json_encode( $data ) ), $invoice_id );
+            wpinv_update_payment_status( $invoice_id, 'wpi-failed' );
+            wpinv_insert_payment_note( $invoice_id, __( 'Payment failed due to invalid purchase key in PayPal IPN.', 'invoicing' ), '', '', true );
+            return;
+        }
+
+        if ( 'complete' == $payment_status || 'completed' == $payment_status || 'processed' == $payment_status || wpinv_is_test_mode( 'paypal' ) ) {
+            wpinv_insert_payment_note( $invoice_id, sprintf( __( 'PayPal Transaction ID: %s', 'invoicing' ) , $data['txn_id'] ), '', '', true );
+            wpinv_set_payment_transaction_id( $invoice_id, $data['txn_id'] );
+            wpinv_update_payment_status( $invoice_id, 'publish' );
+        } else if ( 'pending' == $payment_status && isset( $data['pending_reason'] ) ) {
+            // Look for possible pending reasons, such as an echeck
+            $note = '';
+
+            switch( strtolower( $data['pending_reason'] ) ) {
+                case 'echeck' :
+                    $note = __( 'Payment made via eCheck and will clear automatically in 5-8 days', 'invoicing' );
+                    break;
 				
                 case 'address' :
-					$note = __( 'Payment requires a confirmed customer address and must be accepted manually through PayPal', 'invoicing' );
-					break;
+                    $note = __( 'Payment requires a confirmed customer address and must be accepted manually through PayPal', 'invoicing' );
+                    break;
 				
                 case 'intl' :
-					$note = __( 'Payment must be accepted manually through PayPal due to international account regulations', 'invoicing' );
-					break;
+                    $note = __( 'Payment must be accepted manually through PayPal due to international account regulations', 'invoicing' );
+                    break;
 				
                 case 'multi-currency' :
-					$note = __( 'Payment received in non-shop currency and must be accepted manually through PayPal', 'invoicing' );
-					break;
+                    $note = __( 'Payment received in non-shop currency and must be accepted manually through PayPal', 'invoicing' );
+                    break;
 				
                 case 'paymentreview' :
                 case 'regulatory_review' :
-					$note = __( 'Payment is being reviewed by PayPal staff as high-risk or in possible violation of government regulations', 'invoicing' );
-					break;
+                    $note = __( 'Payment is being reviewed by PayPal staff as high-risk or in possible violation of government regulations', 'invoicing' );
+                    break;
 				
                 case 'unilateral' :
-					$note = __( 'Payment was sent to non-confirmed or non-registered email address.', 'invoicing' );
-					break;
+                    $note = __( 'Payment was sent to non-confirmed or non-registered email address.', 'invoicing' );
+                    break;
 				
                 case 'upgrade' :
-					$note = __( 'PayPal account must be upgraded before this payment can be accepted', 'invoicing' );
-					break;
+                    $note = __( 'PayPal account must be upgraded before this payment can be accepted', 'invoicing' );
+                    break;
 				
                 case 'verify' :
-					$note = __( 'PayPal account is not verified. Verify account in order to accept this payment', 'invoicing' );
-					break;
-
-				case 'other' :
-					$note = __( 'Payment is pending for unknown reasons. Contact PayPal support for assistance', 'invoicing' );
-					break;
-			}
-
-			if ( ! empty( $note ) ) {
-				wpinv_insert_payment_note( $invoice_id, $note, '', '', true );
-			}
-		} else {
-			wpinv_insert_payment_note( $invoice_id, wp_sprintf( __( 'PayPal IPN has been received with invalid payment status: %s', 'invoicing' ), $payment_status ), '', '', true );
-		}
-	}
+                    $note = __( 'PayPal account is not verified. Verify account in order to accept this payment', 'invoicing' );
+                    break;
+
+                case 'other' :
+                    $note = __( 'Payment is pending for unknown reasons. Contact PayPal support for assistance', 'invoicing' );
+                    break;
+            }
+
+            if ( ! empty( $note ) ) {
+                wpinv_insert_payment_note( $invoice_id, $note, '', '', true );
+            }
+        } else {
+            wpinv_insert_payment_note( $invoice_id, wp_sprintf( __( 'PayPal IPN has been received with invalid payment status: %s', 'invoicing' ), $payment_status ), '', '', true );
+        }
+    }
 }
 add_action( 'wpinv_paypal_web_accept', 'wpinv_process_paypal_web_accept_and_cart', 10, 2 );
 
@@ -661,34 +661,34 @@ 
 }
 
 function wpinv_process_paypal_refund( $data, $invoice_id = 0 ) {
-	// Collect payment details
+    // Collect payment details
 
-	if( empty( $invoice_id ) ) {
-		return;
-	}
+    if( empty( $invoice_id ) ) {
+        return;
+    }
 
-	if ( get_post_status( $invoice_id ) == 'wpi-refunded' ) {
-		return; // Only refund payments once
-	}
+    if ( get_post_status( $invoice_id ) == 'wpi-refunded' ) {
+        return; // Only refund payments once
+    }
 
-	$payment_amount = wpinv_payment_total( $invoice_id );
-	$refund_amount  = $data['mc_gross'] * -1;
+    $payment_amount = wpinv_payment_total( $invoice_id );
+    $refund_amount  = $data['mc_gross'] * -1;
 
-	do_action( 'wpinv_paypal_refund_request', $data, $invoice_id );
+    do_action( 'wpinv_paypal_refund_request', $data, $invoice_id );
 
-	if ( number_format( (float) $refund_amount, 2 ) < number_format( (float) $payment_amount, 2 ) ) {
-		wpinv_insert_payment_note( $invoice_id, wp_sprintf( __( 'PayPal partial refund of %s processed for transaction #%s for reason: %s', 'invoicing' ), (float)$refund_amount . ' '. $data['mc_currency'], $data['parent_txn_id'], $data['reason_code'] ), '', '', true );
+    if ( number_format( (float) $refund_amount, 2 ) < number_format( (float) $payment_amount, 2 ) ) {
+        wpinv_insert_payment_note( $invoice_id, wp_sprintf( __( 'PayPal partial refund of %s processed for transaction #%s for reason: %s', 'invoicing' ), (float)$refund_amount . ' '. $data['mc_currency'], $data['parent_txn_id'], $data['reason_code'] ), '', '', true );
 
-		do_action( 'wpinv_paypal_invoice_partially_refunded', $data, $invoice_id, $refund_amount );
+        do_action( 'wpinv_paypal_invoice_partially_refunded', $data, $invoice_id, $refund_amount );
 
-		return; // This is a partial refund
-	}
+        return; // This is a partial refund
+    }
 
-	wpinv_insert_payment_note( $invoice_id, sprintf( __( 'PayPal Payment #%s Refunded for reason: %s', 'invoicing' ), $data['parent_txn_id'], $data['reason_code'] ), '', '', true );
-	wpinv_insert_payment_note( $invoice_id, sprintf( __( 'PayPal Refund Transaction ID: %s', 'invoicing' ), $data['txn_id'] ), '', '', true );
-	wpinv_update_payment_status( $invoice_id, 'wpi-refunded' );
+    wpinv_insert_payment_note( $invoice_id, sprintf( __( 'PayPal Payment #%s Refunded for reason: %s', 'invoicing' ), $data['parent_txn_id'], $data['reason_code'] ), '', '', true );
+    wpinv_insert_payment_note( $invoice_id, sprintf( __( 'PayPal Refund Transaction ID: %s', 'invoicing' ), $data['txn_id'] ), '', '', true );
+    wpinv_update_payment_status( $invoice_id, 'wpi-refunded' );
 
-	do_action( 'wpinv_paypal_invoice_fully_refunded', $data, $invoice_id );
+    do_action( 'wpinv_paypal_invoice_fully_refunded', $data, $invoice_id );
 }
 
 function wpinv_get_paypal_redirect( $ssl_check = false ) {

includes/wpinv-template-functions.php

Indentation +95 added lines, -95 removed lines

@@ -103,29 +103,29 @@ 
 
 function wpinv_get_template( $template_name, $args = array(), $template_path = '', $default_path = '' ) {
     if ( ! empty( $args ) && is_array( $args ) ) {
-		extract( $args );
-	}
+        extract( $args );
+    }
 
-	$located = wpinv_locate_template( $template_name, $template_path, $default_path );
-	// Allow 3rd party plugin filter template file from their plugin.
-	$located = apply_filters( 'wpinv_get_template', $located, $template_name, $args, $template_path, $default_path );
+    $located = wpinv_locate_template( $template_name, $template_path, $default_path );
+    // Allow 3rd party plugin filter template file from their plugin.
+    $located = apply_filters( 'wpinv_get_template', $located, $template_name, $args, $template_path, $default_path );
 
-	if ( ! file_exists( $located ) ) {
+    if ( ! file_exists( $located ) ) {
         _doing_it_wrong( __FUNCTION__, sprintf( '<code>%s</code> does not exist.', $located ), '2.1' );
-		return;
-	}
+        return;
+    }
 
-	do_action( 'wpinv_before_template_part', $template_name, $template_path, $located, $args );
+    do_action( 'wpinv_before_template_part', $template_name, $template_path, $located, $args );
 
-	include( $located );
+    include( $located );
 
-	do_action( 'wpinv_after_template_part', $template_name, $template_path, $located, $args );
+    do_action( 'wpinv_after_template_part', $template_name, $template_path, $located, $args );
 }
 
 function wpinv_get_template_html( $template_name, $args = array(), $template_path = '', $default_path = '' ) {
-	ob_start();
-	wpinv_get_template( $template_name, $args, $template_path, $default_path );
-	return ob_get_clean();
+    ob_start();
+    wpinv_get_template( $template_name, $args, $template_path, $default_path );
+    return ob_get_clean();
 }
 
 function wpinv_locate_template( $template_name, $template_path = '', $default_path = '' ) {
@@ -155,126 +155,126 @@ 
 }
 
 function wpinv_get_template_part( $slug, $name = null, $load = true ) {
-	do_action( 'get_template_part_' . $slug, $slug, $name );
+    do_action( 'get_template_part_' . $slug, $slug, $name );
 
-	// Setup possible parts
-	$templates = array();
-	if ( isset( $name ) )
-		$templates[] = $slug . '-' . $name . '.php';
-	$templates[] = $slug . '.php';
+    // Setup possible parts
+    $templates = array();
+    if ( isset( $name ) )
+        $templates[] = $slug . '-' . $name . '.php';
+    $templates[] = $slug . '.php';
 
-	// Allow template parts to be filtered
-	$templates = apply_filters( 'wpinv_get_template_part', $templates, $slug, $name );
+    // Allow template parts to be filtered
+    $templates = apply_filters( 'wpinv_get_template_part', $templates, $slug, $name );
 
-	// Return the part that is found
-	return wpinv_locate_tmpl( $templates, $load, false );
+    // Return the part that is found
+    return wpinv_locate_tmpl( $templates, $load, false );
 }
 
 function wpinv_locate_tmpl( $template_names, $load = false, $require_once = true ) {
-	// No file found yet
-	$located = false;
+    // No file found yet
+    $located = false;
 
-	// Try to find a template file
-	foreach ( (array)$template_names as $template_name ) {
+    // Try to find a template file
+    foreach ( (array)$template_names as $template_name ) {
 
-		// Continue if template is empty
-		if ( empty( $template_name ) )
-			continue;
+        // Continue if template is empty
+        if ( empty( $template_name ) )
+            continue;
 
-		// Trim off any slashes from the template name
-		$template_name = ltrim( $template_name, '/' );
+        // Trim off any slashes from the template name
+        $template_name = ltrim( $template_name, '/' );
 
-		// try locating this template file by looping through the template paths
-		foreach( wpinv_get_theme_template_paths() as $template_path ) {
+        // try locating this template file by looping through the template paths
+        foreach( wpinv_get_theme_template_paths() as $template_path ) {
 
-			if( file_exists( $template_path . $template_name ) ) {
-				$located = $template_path . $template_name;
-				break;
-			}
-		}
+            if( file_exists( $template_path . $template_name ) ) {
+                $located = $template_path . $template_name;
+                break;
+            }
+        }
 
-		if( !empty( $located ) ) {
-			break;
-		}
-	}
+        if( !empty( $located ) ) {
+            break;
+        }
+    }
 
-	if ( ( true == $load ) && ! empty( $located ) )
-		load_template( $located, $require_once );
+    if ( ( true == $load ) && ! empty( $located ) )
+        load_template( $located, $require_once );
 
-	return $located;
+    return $located;
 }
 
 function wpinv_get_theme_template_paths() {
-	$template_dir = wpinv_get_theme_template_dir_name();
+    $template_dir = wpinv_get_theme_template_dir_name();
 
-	$file_paths = array(
-		1 => trailingslashit( get_stylesheet_directory() ) . $template_dir,
-		10 => trailingslashit( get_template_directory() ) . $template_dir,
-		100 => wpinv_get_templates_dir()
-	);
+    $file_paths = array(
+        1 => trailingslashit( get_stylesheet_directory() ) . $template_dir,
+        10 => trailingslashit( get_template_directory() ) . $template_dir,
+        100 => wpinv_get_templates_dir()
+    );
 
-	$file_paths = apply_filters( 'wpinv_template_paths', $file_paths );
+    $file_paths = apply_filters( 'wpinv_template_paths', $file_paths );
 
-	// sort the file paths based on priority
-	ksort( $file_paths, SORT_NUMERIC );
+    // sort the file paths based on priority
+    ksort( $file_paths, SORT_NUMERIC );
 
-	return array_map( 'trailingslashit', $file_paths );
+    return array_map( 'trailingslashit', $file_paths );
 }
 
 function wpinv_get_theme_template_dir_name() {
-	return trailingslashit( apply_filters( 'wpinv_templates_dir', 'invoicing' ) );
+    return trailingslashit( apply_filters( 'wpinv_templates_dir', 'invoicing' ) );
 }
 
 function wpinv_checkout_meta_tags() {
 
-	$pages   = array();
-	$pages[] = wpinv_get_option( 'success_page' );
-	$pages[] = wpinv_get_option( 'failure_page' );
-	$pages[] = wpinv_get_option( 'invoice_history_page' );
-	$pages[] = wpinv_get_option( 'invoice_subscription_page' );
+    $pages   = array();
+    $pages[] = wpinv_get_option( 'success_page' );
+    $pages[] = wpinv_get_option( 'failure_page' );
+    $pages[] = wpinv_get_option( 'invoice_history_page' );
+    $pages[] = wpinv_get_option( 'invoice_subscription_page' );
 
-	if( !wpinv_is_checkout() && !is_page( $pages ) ) {
-		return;
-	}
+    if( !wpinv_is_checkout() && !is_page( $pages ) ) {
+        return;
+    }
 
-	echo '<meta name="robots" content="noindex,nofollow" />' . "\n";
+    echo '<meta name="robots" content="noindex,nofollow" />' . "\n";
 }
 add_action( 'wp_head', 'wpinv_checkout_meta_tags' );
 
 function wpinv_add_body_classes( $class ) {
-	$classes = (array)$class;
+    $classes = (array)$class;
 
-	if( wpinv_is_checkout() ) {
-		$classes[] = 'wpinv-checkout';
-		$classes[] = 'wpinv-page';
-	}
+    if( wpinv_is_checkout() ) {
+        $classes[] = 'wpinv-checkout';
+        $classes[] = 'wpinv-page';
+    }
 
-	if( wpinv_is_success_page() ) {
-		$classes[] = 'wpinv-success';
-		$classes[] = 'wpinv-page';
-	}
+    if( wpinv_is_success_page() ) {
+        $classes[] = 'wpinv-success';
+        $classes[] = 'wpinv-page';
+    }
 
-	if( wpinv_is_failed_transaction_page() ) {
-		$classes[] = 'wpinv-failed-transaction';
-		$classes[] = 'wpinv-page';
-	}
+    if( wpinv_is_failed_transaction_page() ) {
+        $classes[] = 'wpinv-failed-transaction';
+        $classes[] = 'wpinv-page';
+    }
 
-	if( wpinv_is_invoice_history_page() ) {
-		$classes[] = 'wpinv-history';
-		$classes[] = 'wpinv-page';
-	}
+    if( wpinv_is_invoice_history_page() ) {
+        $classes[] = 'wpinv-history';
+        $classes[] = 'wpinv-page';
+    }
 
-	if( wpinv_is_subscriptions_history_page() ) {
-		$classes[] = 'wpinv-subscription';
-		$classes[] = 'wpinv-page';
-	}
+    if( wpinv_is_subscriptions_history_page() ) {
+        $classes[] = 'wpinv-subscription';
+        $classes[] = 'wpinv-page';
+    }
 
-	if( wpinv_is_test_mode() ) {
-		$classes[] = 'wpinv-test-mode';
-		$classes[] = 'wpinv-page';
-	}
+    if( wpinv_is_test_mode() ) {
+        $classes[] = 'wpinv-test-mode';
+        $classes[] = 'wpinv-page';
+    }
 
-	return array_unique( $classes );
+    return array_unique( $classes );
 }
 add_filter( 'body_class', 'wpinv_add_body_classes' );
 
@@ -1408,7 +1408,7 @@ 
 add_action( 'wpinv_checkout_cart', 'wpinv_checkout_cart', 10 );
 
 function wpinv_empty_cart_message() {
-	return apply_filters( 'wpinv_empty_cart_message', '<span class="wpinv_empty_cart">' . __( 'Your cart is empty.', 'invoicing' ) . '</span>' );
+    return apply_filters( 'wpinv_empty_cart_message', '<span class="wpinv_empty_cart">' . __( 'Your cart is empty.', 'invoicing' ) . '</span>' );
 }
 
 /**
@@ -1418,7 +1418,7 @@ 
  * @return void
  */
 function wpinv_empty_checkout_cart() {
-	echo wpinv_empty_cart_message();
+    echo wpinv_empty_cart_message();
 }
 add_action( 'wpinv_cart_empty', 'wpinv_empty_checkout_cart' );