AyeCode / invoicing

includes/admin/register-settings.php

Indentation +369 added lines, -369 removed lines

@@ -25,8 +25,8 @@ 
                     $defaults[ $key ] = $setting['std'];
                 }
             }
-		}
-	}
+        }
+    }
 
     return $defaults;
 
@@ -144,7 +144,7 @@ 
  *
  */
 function wpinv_register_settings() {
-	do_action( 'getpaid_before_register_settings' );
+    do_action( 'getpaid_before_register_settings' );
 
     // Loop through all tabs.
     foreach ( wpinv_get_registered_settings() as $tab => $sections ) {
@@ -159,7 +159,7 @@ 
                 $settings = $sections;
             }
 
-			do_action( "getpaid_register_{$tab}_{$section}" );
+            do_action( "getpaid_register_{$tab}_{$section}" );
 
             // Register the setting section.
             add_settings_section(
@@ -180,7 +180,7 @@ 
     // Creates our settings in the options table.
     register_setting( 'wpinv_settings', 'wpinv_settings', 'wpinv_settings_sanitize' );
 
-	do_action( 'getpaid_after_register_settings' );
+    do_action( 'getpaid_after_register_settings' );
 }
 add_action( 'admin_init', 'wpinv_register_settings' );
 
@@ -197,13 +197,13 @@ 
     $name       = isset( $option['name'] ) ? $option['name'] : '';
     $cb         = "wpinv_{$option['type']}_callback";
     $section    = "wpinv_settings_{$tab}_$section";
-	$is_wizzard = is_admin() && isset( $_GET['page'] ) && 'gp-setup' == $_GET['page'];
+    $is_wizzard = is_admin() && isset( $_GET['page'] ) && 'gp-setup' == $_GET['page'];
 
-	if ( isset( $option['desc'] ) && ( ! $is_wizzard && ! empty( $option['help-tip'] ) ) ) {
-		$tip   = wpinv_clean( $option['desc'] );
-		$name .= "<span class='dashicons dashicons-editor-help wpi-help-tip' title='$tip'></span>";
-		unset( $option['desc'] );
-	}
+    if ( isset( $option['desc'] ) && ( ! $is_wizzard && ! empty( $option['help-tip'] ) ) ) {
+        $tip   = wpinv_clean( $option['desc'] );
+        $name .= "<span class='dashicons dashicons-editor-help wpi-help-tip' title='$tip'></span>";
+        unset( $option['desc'] );
+    }
 
     // Loop through all tabs.
     add_settings_field(
@@ -230,9 +230,9 @@ 
             'faux'            => isset( $option['faux'] ) ? $option['faux'] : false,
             'onchange'        => isset( $option['onchange'] ) ? $option['onchange'] : '',
             'custom'          => isset( $option['custom'] ) ? $option['custom'] : '',
-			'default_content' => isset( $option['default_content'] ) ? $option['default_content'] : '',
-			'class'           => isset( $option['class'] ) ? $option['class'] : '',
-			'style'           => isset( $option['style'] ) ? $option['style'] : '',
+            'default_content' => isset( $option['default_content'] ) ? $option['default_content'] : '',
+            'class'           => isset( $option['class'] ) ? $option['class'] : '',
+            'style'           => isset( $option['style'] ) ? $option['style'] : '',
             'cols'            => isset( $option['cols'] ) && (int) $option['cols'] > 0 ? (int) $option['cols'] : 50,
             'rows'            => isset( $option['rows'] ) && (int) $option['rows'] > 0 ? (int) $option['rows'] : 5,
         )
@@ -246,7 +246,7 @@ 
  * @return array
  */
 function wpinv_get_registered_settings() {
-	return array_filter( apply_filters( 'wpinv_registered_settings', wpinv_get_data( 'admin-settings' ) ) );
+    return array_filter( apply_filters( 'wpinv_registered_settings', wpinv_get_data( 'admin-settings' ) ) );
 }
 
 /**
@@ -265,18 +265,18 @@ 
  */
 function wpinv_settings_sanitize( $input = array() ) {
 
-	$wpinv_options = wpinv_get_options();
-	$raw_referrer  = wp_get_raw_referer();
+    $wpinv_options = wpinv_get_options();
+    $raw_referrer  = wp_get_raw_referer();
 
     if ( empty( $raw_referrer ) ) {
-		return array_merge( $wpinv_options, $input );
+        return array_merge( $wpinv_options, $input );
     }
 
     wp_parse_str( $raw_referrer, $referrer );
 
-	if ( in_array( 'gp-setup', $referrer ) ) {
-		return array_merge( $wpinv_options, $input );
-	}
+    if ( in_array( 'gp-setup', $referrer ) ) {
+        return array_merge( $wpinv_options, $input );
+    }
 
     $settings = wpinv_get_registered_settings();
     $tab      = isset( $referrer['tab'] ) ? $referrer['tab'] : 'general';
@@ -298,10 +298,10 @@ 
         }
 
         // General filter
-		$input[ $key ] = apply_filters( 'wpinv_settings_sanitize', $input[ $key ], $key );
+        $input[ $key ] = apply_filters( 'wpinv_settings_sanitize', $input[ $key ], $key );
 
-		// Key specific filter.
-		$input[ $key ] = apply_filters( "wpinv_settings_sanitize_$key", $input[ $key ] );
+        // Key specific filter.
+        $input[ $key ] = apply_filters( "wpinv_settings_sanitize_$key", $input[ $key ] );
     }
 
     // Loop through the whitelist and unset any that are empty for the tab being saved
@@ -344,14 +344,14 @@ 
 
     foreach ( $new_rates as $rate ) {
 
-		$rate['rate']    = wpinv_sanitize_amount( $rate['rate'] );
-		$rate['name']    = sanitize_text_field( $rate['name'] );
-		$rate['state']   = sanitize_text_field( $rate['state'] );
-		$rate['country'] = sanitize_text_field( $rate['country'] );
-		$rate['global']  = empty( $rate['state'] );
-		$tax_rates[]     = $rate;
+        $rate['rate']    = wpinv_sanitize_amount( $rate['rate'] );
+        $rate['name']    = sanitize_text_field( $rate['name'] );
+        $rate['state']   = sanitize_text_field( $rate['state'] );
+        $rate['country'] = sanitize_text_field( $rate['country'] );
+        $rate['global']  = empty( $rate['state'] );
+        $tax_rates[]     = $rate;
 
-	}
+    }
 
     update_option( 'wpinv_tax_rates', $tax_rates );
 
@@ -364,21 +364,21 @@ 
         return $input;
     }
 
-	if ( empty( $_POST['wpinv_tax_rules_nonce'] ) || ! wp_verify_nonce( $_POST['wpinv_tax_rules_nonce'], 'wpinv_tax_rules' ) ) {
-		return $input;
-	}
+    if ( empty( $_POST['wpinv_tax_rules_nonce'] ) || ! wp_verify_nonce( $_POST['wpinv_tax_rules_nonce'], 'wpinv_tax_rules' ) ) {
+        return $input;
+    }
 
     $new_rules = ! empty( $_POST['tax_rules'] ) ? wp_kses_post_deep( array_values( $_POST['tax_rules'] ) ) : array();
     $tax_rules = array();
 
     foreach ( $new_rules as $rule ) {
 
-		$rule['key']      = sanitize_title_with_dashes( $rule['key'] );
-		$rule['label']    = sanitize_text_field( $rule['label'] );
-		$rule['tax_base'] = sanitize_text_field( $rule['tax_base'] );
-		$tax_rules[]      = $rule;
+        $rule['key']      = sanitize_title_with_dashes( $rule['key'] );
+        $rule['label']    = sanitize_text_field( $rule['label'] );
+        $rule['tax_base'] = sanitize_text_field( $rule['tax_base'] );
+        $tax_rules[]      = $rule;
 
-	}
+    }
 
     update_option( 'wpinv_tax_rules', $tax_rules );
 
@@ -391,11 +391,11 @@ 
     $tabs['general']  = __( 'General', 'invoicing' );
     $tabs['gateways'] = __( 'Payment Gateways', 'invoicing' );
     $tabs['taxes']    = __( 'Taxes', 'invoicing' );
-	$tabs['emails']   = __( 'Emails', 'invoicing' );
+    $tabs['emails']   = __( 'Emails', 'invoicing' );
 
-	if ( count( getpaid_get_integration_settings() ) > 0 ) {
-		$tabs['integrations'] = __( 'Integrations', 'invoicing' );
-	}
+    if ( count( getpaid_get_integration_settings() ) > 0 ) {
+        $tabs['integrations'] = __( 'Integrations', 'invoicing' );
+    }
 
     $tabs['privacy']  = __( 'Privacy', 'invoicing' );
     $tabs['misc']     = __( 'Misc', 'invoicing' );
@@ -426,53 +426,53 @@ 
         'general'      => apply_filters(
             'wpinv_settings_sections_general',
             array(
-				'main'             => __( 'General Settings', 'invoicing' ),
-				'page_section'     => __( 'Page Settings', 'invoicing' ),
-				'currency_section' => __( 'Currency Settings', 'invoicing' ),
-				'labels'           => __( 'Label Texts', 'invoicing' ),
+                'main'             => __( 'General Settings', 'invoicing' ),
+                'page_section'     => __( 'Page Settings', 'invoicing' ),
+                'currency_section' => __( 'Currency Settings', 'invoicing' ),
+                'labels'           => __( 'Label Texts', 'invoicing' ),
             )
         ),
         'gateways'     => apply_filters(
             'wpinv_settings_sections_gateways',
             array(
-				'main' => __( 'Gateway Settings', 'invoicing' ),
+                'main' => __( 'Gateway Settings', 'invoicing' ),
             )
         ),
         'taxes'        => apply_filters(
             'wpinv_settings_sections_taxes',
             array(
-				'main'  => __( 'Tax Settings', 'invoicing' ),
-				'rules' => __( 'Tax Rules', 'invoicing' ),
-				'rates' => __( 'Tax Rates', 'invoicing' ),
-				'vat'   => __( 'EU VAT Settings', 'invoicing' ),
+                'main'  => __( 'Tax Settings', 'invoicing' ),
+                'rules' => __( 'Tax Rules', 'invoicing' ),
+                'rates' => __( 'Tax Rates', 'invoicing' ),
+                'vat'   => __( 'EU VAT Settings', 'invoicing' ),
             )
         ),
         'emails'       => apply_filters(
             'wpinv_settings_sections_emails',
             array(
-				'main' => __( 'Email Settings', 'invoicing' ),
+                'main' => __( 'Email Settings', 'invoicing' ),
             )
         ),
 
-		'integrations' => wp_list_pluck( getpaid_get_integration_settings(), 'label', 'id' ),
+        'integrations' => wp_list_pluck( getpaid_get_integration_settings(), 'label', 'id' ),
 
         'privacy'      => apply_filters(
             'wpinv_settings_sections_privacy',
             array(
-				'main' => __( 'Privacy policy', 'invoicing' ),
+                'main' => __( 'Privacy policy', 'invoicing' ),
             )
         ),
         'misc'         => apply_filters(
             'wpinv_settings_sections_misc',
             array(
-				'main'       => __( 'Miscellaneous', 'invoicing' ),
-				'custom-css' => __( 'Custom CSS', 'invoicing' ),
+                'main'       => __( 'Miscellaneous', 'invoicing' ),
+                'custom-css' => __( 'Custom CSS', 'invoicing' ),
             )
         ),
         'tools'        => apply_filters(
             'wpinv_settings_sections_tools',
             array(
-				'main' => __( 'Diagnostic Tools', 'invoicing' ),
+                'main' => __( 'Diagnostic Tools', 'invoicing' ),
             )
         ),
     );
@@ -483,46 +483,46 @@ 
 }
 
 function wpinv_get_pages( $with_slug = false, $default_label = null ) {
-	$pages_options = array();
+    $pages_options = array();
 
-	if ( $default_label !== null && $default_label !== false ) {
-		$pages_options = array( '' => $default_label ); // Blank option
-	}
+    if ( $default_label !== null && $default_label !== false ) {
+        $pages_options = array( '' => $default_label ); // Blank option
+    }
 
-	$pages = get_pages();
-	if ( $pages ) {
-		foreach ( $pages as $page ) {
-			$title = $with_slug ? $page->post_title . ' (' . $page->post_name . ')' : $page->post_title;
+    $pages = get_pages();
+    if ( $pages ) {
+        foreach ( $pages as $page ) {
+            $title = $with_slug ? $page->post_title . ' (' . $page->post_name . ')' : $page->post_title;
             $pages_options[ $page->ID ] = $title;
-		}
-	}
+        }
+    }
 
-	return $pages_options;
+    return $pages_options;
 }
 
 function wpinv_header_callback( $args ) {
-	if ( ! empty( $args['desc'] ) ) {
+    if ( ! empty( $args['desc'] ) ) {
         echo wp_kses_post( $args['desc'] );
     }
 }
 
 function wpinv_hidden_callback( $args ) {
 
-	$std     = isset( $args['std'] ) ? $args['std'] : '';
-	$value   = wpinv_get_option( $args['id'], $std );
+    $std     = isset( $args['std'] ) ? $args['std'] : '';
+    $value   = wpinv_get_option( $args['id'], $std );
 
-	if ( isset( $args['set_value'] ) ) {
-		$value = $args['set_value'];
-	}
+    if ( isset( $args['set_value'] ) ) {
+        $value = $args['set_value'];
+    }
 
-	if ( isset( $args['faux'] ) && true === $args['faux'] ) {
-		$args['readonly'] = true;
-		$name  = '';
-	} else {
-		$name = 'wpinv_settings[' . esc_attr( $args['id'] ) . ']';
-	}
+    if ( isset( $args['faux'] ) && true === $args['faux'] ) {
+        $args['readonly'] = true;
+        $name  = '';
+    } else {
+        $name = 'wpinv_settings[' . esc_attr( $args['id'] ) . ']';
+    }
 
-	echo '<input type="hidden" id="wpinv_settings[' . esc_attr( $args['id'] ) . ']" name="' . esc_attr( $name ) . '" value="' . esc_attr( stripslashes( $value ) ) . '" />';
+    echo '<input type="hidden" id="wpinv_settings[' . esc_attr( $args['id'] ) . ']" name="' . esc_attr( $name ) . '" value="' . esc_attr( stripslashes( $value ) ) . '" />';
 
 }
 
@@ -531,12 +531,12 @@ 
  */
 function wpinv_checkbox_callback( $args ) {
 
-	$std = isset( $args['std'] ) ? $args['std'] : '';
-	$std = wpinv_get_option( $args['id'], $std );
-	$id  = esc_attr( $args['id'] );
+    $std = isset( $args['std'] ) ? $args['std'] : '';
+    $std = wpinv_get_option( $args['id'], $std );
+    $id  = esc_attr( $args['id'] );
 
-	getpaid_hidden_field( "wpinv_settings[$id]", '0' );
-	?>
+    getpaid_hidden_field( "wpinv_settings[$id]", '0' );
+    ?>
 		<label>
 			<input id="wpinv-settings-<?php echo esc_attr( $id ); ?>" name="wpinv_settings[<?php echo esc_attr( $id ); ?>]" <?php checked( empty( $std ), false ); ?> value="1" type="checkbox" />
 			<?php echo wp_kses_post( $args['desc'] ); ?>
@@ -546,75 +546,75 @@ 
 
 function wpinv_multicheck_callback( $args ) {
 
-	$sanitize_id = wpinv_sanitize_key( $args['id'] );
-	$class = ! empty( $args['class'] ) ? ' ' . esc_attr( $args['class'] ) : '';
+    $sanitize_id = wpinv_sanitize_key( $args['id'] );
+    $class = ! empty( $args['class'] ) ? ' ' . esc_attr( $args['class'] ) : '';
 
-	if ( ! empty( $args['options'] ) ) {
+    if ( ! empty( $args['options'] ) ) {
 
-		$std     = isset( $args['std'] ) ? $args['std'] : array();
-		$value   = wpinv_get_option( $args['id'], $std );
+        $std     = isset( $args['std'] ) ? $args['std'] : array();
+        $value   = wpinv_get_option( $args['id'], $std );
 
-		echo '<div class="wpi-mcheck-rows wpi-mcheck-' . esc_attr( $sanitize_id . $class ) . '">';
+        echo '<div class="wpi-mcheck-rows wpi-mcheck-' . esc_attr( $sanitize_id . $class ) . '">';
         foreach ( $args['options'] as $key => $option ) :
-			$sanitize_key = esc_attr( wpinv_sanitize_key( $key ) );
-			if ( in_array( $sanitize_key, $value ) ) {
-				$enabled = $sanitize_key;
-			} else {
-				$enabled = null;
-			}
-			echo '<div class="wpi-mcheck-row"><input name="wpinv_settings[' . esc_attr( $sanitize_id ) . '][' . esc_attr( $sanitize_key ) . ']" id="wpinv_settings[' . esc_attr( $sanitize_id ) . '][' . esc_attr( $sanitize_key ) . ']" type="checkbox" value="' . esc_attr( $sanitize_key ) . '" ' . checked( $sanitize_key, $enabled, false ) . '/>&nbsp;';
-			echo '<label for="wpinv_settings[' . esc_attr( $sanitize_id ) . '][' . esc_attr( $sanitize_key ) . ']">' . wp_kses_post( $option ) . '</label></div>';
-		endforeach;
-		echo '</div>';
-		echo '<p class="description">' . wp_kses_post( $args['desc'] ) . '</p>';
-	}
+            $sanitize_key = esc_attr( wpinv_sanitize_key( $key ) );
+            if ( in_array( $sanitize_key, $value ) ) {
+                $enabled = $sanitize_key;
+            } else {
+                $enabled = null;
+            }
+            echo '<div class="wpi-mcheck-row"><input name="wpinv_settings[' . esc_attr( $sanitize_id ) . '][' . esc_attr( $sanitize_key ) . ']" id="wpinv_settings[' . esc_attr( $sanitize_id ) . '][' . esc_attr( $sanitize_key ) . ']" type="checkbox" value="' . esc_attr( $sanitize_key ) . '" ' . checked( $sanitize_key, $enabled, false ) . '/>&nbsp;';
+            echo '<label for="wpinv_settings[' . esc_attr( $sanitize_id ) . '][' . esc_attr( $sanitize_key ) . ']">' . wp_kses_post( $option ) . '</label></div>';
+        endforeach;
+        echo '</div>';
+        echo '<p class="description">' . wp_kses_post( $args['desc'] ) . '</p>';
+    }
 }
 
 function wpinv_payment_icons_callback( $args ) {
 
     $sanitize_id = wpinv_sanitize_key( $args['id'] );
-	$value   = wpinv_get_option( $args['id'], false );
+    $value   = wpinv_get_option( $args['id'], false );
 
-	if ( ! empty( $args['options'] ) ) {
-		foreach ( $args['options'] as $key => $option ) {
+    if ( ! empty( $args['options'] ) ) {
+        foreach ( $args['options'] as $key => $option ) {
             $sanitize_key = wpinv_sanitize_key( $key );
 
-			if ( empty( $value ) ) {
-				$enabled = $option;
-			} else {
-				$enabled = null;
-			}
-
-			echo '<label for="wpinv_settings[' . esc_attr( $sanitize_id ) . '][' . esc_attr( $sanitize_key ) . ']" style="margin-right:10px;line-height:16px;height:16px;display:inline-block;">';
-
-				echo '<input name="wpinv_settings[' . esc_attr( $sanitize_id ) . '][' . esc_attr( $sanitize_key ) . ']" id="wpinv_settings[' . esc_attr( $sanitize_id ) . '][' . esc_attr( $sanitize_key ) . ']" type="checkbox" value="' . esc_attr( $option ) . '" ' . checked( $option, $enabled, false ) . '/>&nbsp;';
-
-				if ( wpinv_string_is_image_url( $key ) ) {
-				echo '<img class="payment-icon" src="' . esc_url( $key ) . '" style="width:32px;height:24px;position:relative;top:6px;margin-right:5px;"/>';
-				} else {
-				$card = strtolower( str_replace( ' ', '', $option ) );
-
-				if ( has_filter( 'wpinv_accepted_payment_' . $card . '_image' ) ) {
-					$image = apply_filters( 'wpinv_accepted_payment_' . $card . '_image', '' );
-					} else {
-					$image       = wpinv_locate_template( 'images' . DIRECTORY_SEPARATOR . 'icons' . DIRECTORY_SEPARATOR . $card . '.gif', false );
-					$content_dir = WP_CONTENT_DIR;
-
-					if ( function_exists( 'wp_normalize_path' ) ) {
-						// Replaces backslashes with forward slashes for Windows systems
-						$image = wp_normalize_path( $image );
-						$content_dir = wp_normalize_path( $content_dir );
-						}
-
-					$image = str_replace( $content_dir, content_url(), $image );
-					}
-
-				echo '<img class="payment-icon" src="' . esc_url( $image ) . '" style="width:32px;height:24px;position:relative;top:6px;margin-right:5px;"/>';
-				}
-			echo wp_kses_post( $option ) . '</label>';
-		}
-		echo '<p class="description" style="margin-top:16px;">' . wp_kses_post( $args['desc'] ) . '</p>';
-	}
+            if ( empty( $value ) ) {
+                $enabled = $option;
+            } else {
+                $enabled = null;
+            }
+
+            echo '<label for="wpinv_settings[' . esc_attr( $sanitize_id ) . '][' . esc_attr( $sanitize_key ) . ']" style="margin-right:10px;line-height:16px;height:16px;display:inline-block;">';
+
+                echo '<input name="wpinv_settings[' . esc_attr( $sanitize_id ) . '][' . esc_attr( $sanitize_key ) . ']" id="wpinv_settings[' . esc_attr( $sanitize_id ) . '][' . esc_attr( $sanitize_key ) . ']" type="checkbox" value="' . esc_attr( $option ) . '" ' . checked( $option, $enabled, false ) . '/>&nbsp;';
+
+                if ( wpinv_string_is_image_url( $key ) ) {
+                echo '<img class="payment-icon" src="' . esc_url( $key ) . '" style="width:32px;height:24px;position:relative;top:6px;margin-right:5px;"/>';
+                } else {
+                $card = strtolower( str_replace( ' ', '', $option ) );
+
+                if ( has_filter( 'wpinv_accepted_payment_' . $card . '_image' ) ) {
+                    $image = apply_filters( 'wpinv_accepted_payment_' . $card . '_image', '' );
+                    } else {
+                    $image       = wpinv_locate_template( 'images' . DIRECTORY_SEPARATOR . 'icons' . DIRECTORY_SEPARATOR . $card . '.gif', false );
+                    $content_dir = WP_CONTENT_DIR;
+
+                    if ( function_exists( 'wp_normalize_path' ) ) {
+                        // Replaces backslashes with forward slashes for Windows systems
+                        $image = wp_normalize_path( $image );
+                        $content_dir = wp_normalize_path( $content_dir );
+                        }
+
+                    $image = str_replace( $content_dir, content_url(), $image );
+                    }
+
+                echo '<img class="payment-icon" src="' . esc_url( $image ) . '" style="width:32px;height:24px;position:relative;top:6px;margin-right:5px;"/>';
+                }
+            echo wp_kses_post( $option ) . '</label>';
+        }
+        echo '<p class="description" style="margin-top:16px;">' . wp_kses_post( $args['desc'] ) . '</p>';
+    }
 }
 
 /**
@@ -622,9 +622,9 @@ 
  */
 function wpinv_radio_callback( $args ) {
 
-	$std = isset( $args['std'] ) ? $args['std'] : '';
-	$std = wpinv_get_option( $args['id'], $std );
-	?>
+    $std = isset( $args['std'] ) ? $args['std'] : '';
+    $std = wpinv_get_option( $args['id'], $std );
+    ?>
 		<fieldset>
 			<ul id="wpinv-settings-<?php echo esc_attr( $args['id'] ); ?>" style="margin-top: 0;">
 				<?php foreach ( $args['options'] as $key => $option ) : ?>
@@ -638,7 +638,7 @@ 
 			</ul>
 		</fieldset>
 	<?php
-	getpaid_settings_description_callback( $args );
+    getpaid_settings_description_callback( $args );
 }
 
 /**
@@ -646,10 +646,10 @@ 
  */
 function getpaid_settings_description_callback( $args ) {
 
-	if ( ! empty( $args['desc'] ) ) {
-		$description = $args['desc'];
-		echo wp_kses_post( "<p class='description'>$description</p>" );
-	}
+    if ( ! empty( $args['desc'] ) ) {
+        $description = $args['desc'];
+        echo wp_kses_post( "<p class='description'>$description</p>" );
+    }
 
 }
 
@@ -658,7 +658,7 @@ 
  */
 function wpinv_gateways_callback() {
 
-	?>
+    ?>
 		</td>
 	</tr>
 	<tr class="bsui">
@@ -672,26 +672,26 @@ 
 
     $sanitize_id = wpinv_sanitize_key( $args['id'] );
     $class = ! empty( $args['class'] ) ? ' ' . esc_attr( $args['class'] ) : '';
-	$std     = isset( $args['std'] ) ? $args['std'] : '';
-	$value   = wpinv_get_option( $args['id'], $std );
+    $std     = isset( $args['std'] ) ? $args['std'] : '';
+    $value   = wpinv_get_option( $args['id'], $std );
 
-	echo '<select name="wpinv_settings[' . esc_attr( $sanitize_id ) . ']"" id="wpinv_settings[' . esc_attr( $sanitize_id ) . ']" class="' . esc_attr( $class ) . '" >';
+    echo '<select name="wpinv_settings[' . esc_attr( $sanitize_id ) . ']"" id="wpinv_settings[' . esc_attr( $sanitize_id ) . ']" class="' . esc_attr( $class ) . '" >';
 
-	foreach ( $args['options'] as $key => $option ) :
+    foreach ( $args['options'] as $key => $option ) :
 
-		echo '<option value="' . esc_attr( $key ) . '" ';
+        echo '<option value="' . esc_attr( $key ) . '" ';
 
-		if ( isset( $args['selected'] ) && $args['selected'] !== null && $args['selected'] !== false ) {
+        if ( isset( $args['selected'] ) && $args['selected'] !== null && $args['selected'] !== false ) {
             selected( $key, $args['selected'] );
         } else {
             selected( $key, $value );
         }
 
-		echo '>' . esc_html( $option['admin_label'] ) . '</option>';
-	endforeach;
+        echo '>' . esc_html( $option['admin_label'] ) . '</option>';
+    endforeach;
 
-	echo '</select>';
-	echo '<label for="wpinv_settings[' . esc_attr( $sanitize_id ) . ']"> ' . wp_kses_post( $args['desc'] ) . '</label>';
+    echo '</select>';
+    echo '<label for="wpinv_settings[' . esc_attr( $sanitize_id ) . ']"> ' . wp_kses_post( $args['desc'] ) . '</label>';
 }
 
 /**
@@ -702,38 +702,38 @@ 
  */
 function wpinv_settings_attrs_helper( $args ) {
 
-	$value = isset( $args['std'] ) ? $args['std'] : '';
-	$id    = esc_attr( $args['id'] );
-	$value = is_scalar( $value ) ? $value : '';
-
-	$attrs = array(
-		'name'     => ! empty( $args['faux'] ) ? false : "wpinv_settings[$id]",
-		'readonly' => ! empty( $args['faux'] ),
-		'value'    => ! empty( $args['faux'] ) ? $value : wpinv_get_option( $args['id'], $value ),
-		'id'       => 'wpinv-settings-' . $args['id'],
-		'style'    => $args['style'],
-		'class'    => $args['class'],
-		'placeholder' => $args['placeholder'],
-		'data-placeholder' => $args['placeholder'],
-	);
+    $value = isset( $args['std'] ) ? $args['std'] : '';
+    $id    = esc_attr( $args['id'] );
+    $value = is_scalar( $value ) ? $value : '';
+
+    $attrs = array(
+        'name'     => ! empty( $args['faux'] ) ? false : "wpinv_settings[$id]",
+        'readonly' => ! empty( $args['faux'] ),
+        'value'    => ! empty( $args['faux'] ) ? $value : wpinv_get_option( $args['id'], $value ),
+        'id'       => 'wpinv-settings-' . $args['id'],
+        'style'    => $args['style'],
+        'class'    => $args['class'],
+        'placeholder' => $args['placeholder'],
+        'data-placeholder' => $args['placeholder'],
+    );
 
-	if ( ! empty( $args['onchange'] ) ) {
-		$attrs['onchange'] = $args['onchange'];
-	}
+    if ( ! empty( $args['onchange'] ) ) {
+        $attrs['onchange'] = $args['onchange'];
+    }
 
-	foreach ( $attrs as $key => $value ) {
+    foreach ( $attrs as $key => $value ) {
 
-		if ( false === $value ) {
-			continue;
-		}
+        if ( false === $value ) {
+            continue;
+        }
 
-		if ( true === $value ) {
-			echo ' ' . esc_attr( $key );
-		} else {
-			echo ' ' . esc_attr( $key ) . '="' . esc_attr( $value ) . '"';
-		}
+        if ( true === $value ) {
+            echo ' ' . esc_attr( $key );
+        } else {
+            echo ' ' . esc_attr( $key ) . '="' . esc_attr( $value ) . '"';
+        }
 
-	}
+    }
 
 }
 
@@ -742,7 +742,7 @@ 
  */
 function wpinv_text_callback( $args ) {
 
-	?>
+    ?>
 		<label style="width: 100%;">
 			<input type="text" <?php wpinv_settings_attrs_helper( $args ); ?>>
 			<?php getpaid_settings_description_callback( $args ); ?>
@@ -756,7 +756,7 @@ 
  */
 function wpinv_number_callback( $args ) {
 
-	?>
+    ?>
 		<label style="width: 100%;">
 			<input type="number" step="<?php echo esc_attr( $args['step'] ); ?>" max="<?php echo intval( $args['max'] ); ?>" min="<?php echo intval( $args['min'] ); ?>" <?php wpinv_settings_attrs_helper( $args ); ?>>
 			<?php getpaid_settings_description_callback( $args ); ?>
@@ -768,34 +768,34 @@ 
 function wpinv_textarea_callback( $args ) {
 
     $sanitize_id = wpinv_sanitize_key( $args['id'] );
-	$std     = isset( $args['std'] ) ? $args['std'] : '';
-	$value   = wpinv_get_option( $args['id'], $std );
+    $std     = isset( $args['std'] ) ? $args['std'] : '';
+    $value   = wpinv_get_option( $args['id'], $std );
 
     $size = ( isset( $args['size'] ) && ! is_null( $args['size'] ) ) ? $args['size'] : 'regular';
     $class = ( isset( $args['class'] ) && ! is_null( $args['class'] ) ) ? $args['class'] : 'large-text';
 
-	echo '<textarea class="' . esc_attr( $class ) . ' txtarea-' . esc_attr( $size ) . ' wpi-' . esc_attr( sanitize_html_class( $sanitize_id ) ) . ' " cols="' . esc_attr( $args['cols'] ) . '" rows="' . esc_attr( $args['rows'] ) . '" id="wpinv_settings[' . esc_attr( $sanitize_id ) . ']" name="wpinv_settings[' . esc_attr( $args['id'] ) . ']">' . esc_textarea( stripslashes( $value ) ) . '</textarea>';
-	echo '<br /><label for="wpinv_settings[' . esc_attr( $sanitize_id ) . ']"> ' . wp_kses_post( $args['desc'] ) . '</label>';
+    echo '<textarea class="' . esc_attr( $class ) . ' txtarea-' . esc_attr( $size ) . ' wpi-' . esc_attr( sanitize_html_class( $sanitize_id ) ) . ' " cols="' . esc_attr( $args['cols'] ) . '" rows="' . esc_attr( $args['rows'] ) . '" id="wpinv_settings[' . esc_attr( $sanitize_id ) . ']" name="wpinv_settings[' . esc_attr( $args['id'] ) . ']">' . esc_textarea( stripslashes( $value ) ) . '</textarea>';
+    echo '<br /><label for="wpinv_settings[' . esc_attr( $sanitize_id ) . ']"> ' . wp_kses_post( $args['desc'] ) . '</label>';
 
 }
 
 function wpinv_password_callback( $args ) {
 
     $sanitize_id = wpinv_sanitize_key( $args['id'] );
-	$std     = isset( $args['std'] ) ? $args['std'] : '';
-	$value   = wpinv_get_option( $args['id'], $std );
+    $std     = isset( $args['std'] ) ? $args['std'] : '';
+    $value   = wpinv_get_option( $args['id'], $std );
 
-	$size = ( isset( $args['size'] ) && ! is_null( $args['size'] ) ) ? $args['size'] : 'regular';
-	echo '<input type="password" class="' . esc_attr( $size ) . '-text" id="wpinv_settings[' . esc_attr( $sanitize_id ) . ']" name="wpinv_settings[' . esc_attr( $args['id'] ) . ']" value="' . esc_attr( $value ) . '"/>';
-	echo '<label for="wpinv_settings[' . esc_attr( $sanitize_id ) . ']"> ' . wp_kses_post( $args['desc'] ) . '</label>';
+    $size = ( isset( $args['size'] ) && ! is_null( $args['size'] ) ) ? $args['size'] : 'regular';
+    echo '<input type="password" class="' . esc_attr( $size ) . '-text" id="wpinv_settings[' . esc_attr( $sanitize_id ) . ']" name="wpinv_settings[' . esc_attr( $args['id'] ) . ']" value="' . esc_attr( $value ) . '"/>';
+    echo '<label for="wpinv_settings[' . esc_attr( $sanitize_id ) . ']"> ' . wp_kses_post( $args['desc'] ) . '</label>';
 
 }
 
 function wpinv_missing_callback( $args ) {
-	printf(
-		esc_html__( 'The callback function used for the %s setting is missing.', 'invoicing' ),
-		'<strong>' . esc_html( $args['id'] ) . '</strong>'
-	);
+    printf(
+        esc_html__( 'The callback function used for the %s setting is missing.', 'invoicing' ),
+        '<strong>' . esc_html( $args['id'] ) . '</strong>'
+    );
 }
 
 /**
@@ -803,13 +803,13 @@ 
  */
 function wpinv_select_callback( $args ) {
 
-	$desc   = wp_kses_post( $args['desc'] );
-	$desc   = empty( $desc ) ? '' : "<p class='description'>$desc</p>";
-	$value  = isset( $args['std'] ) ? $args['std'] : '';
-	$value  = wpinv_get_option( $args['id'], $value );
-	$rand   = uniqid( 'random_id' );
+    $desc   = wp_kses_post( $args['desc'] );
+    $desc   = empty( $desc ) ? '' : "<p class='description'>$desc</p>";
+    $value  = isset( $args['std'] ) ? $args['std'] : '';
+    $value  = wpinv_get_option( $args['id'], $value );
+    $rand   = uniqid( 'random_id' );
 
-	?>
+    ?>
 		<label style="width: 100%;">
 			<select <?php wpinv_settings_attrs_helper( $args ); ?> data-allow-clear="true">
 				<?php foreach ( $args['options'] as $option => $name ) : ?>
@@ -842,50 +842,50 @@ 
 function wpinv_color_select_callback( $args ) {
 
     $sanitize_id = wpinv_sanitize_key( $args['id'] );
-	$std     = isset( $args['std'] ) ? $args['std'] : '';
-	$value   = wpinv_get_option( $args['id'], $std );
+    $std     = isset( $args['std'] ) ? $args['std'] : '';
+    $value   = wpinv_get_option( $args['id'], $std );
 
-	echo '<select id="wpinv_settings[' . esc_attr( $sanitize_id ) . ']" name="wpinv_settings[' . esc_attr( $args['id'] ) . ']"/>';
+    echo '<select id="wpinv_settings[' . esc_attr( $sanitize_id ) . ']" name="wpinv_settings[' . esc_attr( $args['id'] ) . ']"/>';
 
-	foreach ( $args['options'] as $option => $color ) {
-		echo '<option value="' . esc_attr( $option ) . '" ' . selected( $option, $value ) . '>' . esc_html( $color['label'] ) . '</option>';
-	}
+    foreach ( $args['options'] as $option => $color ) {
+        echo '<option value="' . esc_attr( $option ) . '" ' . selected( $option, $value ) . '>' . esc_html( $color['label'] ) . '</option>';
+    }
 
-	echo '</select>';
-	echo '<label for="wpinv_settings[' . esc_attr( $sanitize_id ) . ']"> ' . wp_kses_post( $args['desc'] ) . '</label>';
+    echo '</select>';
+    echo '<label for="wpinv_settings[' . esc_attr( $sanitize_id ) . ']"> ' . wp_kses_post( $args['desc'] ) . '</label>';
 
 }
 
 function wpinv_rich_editor_callback( $args ) {
-	global $wp_version;
+    global $wp_version;
 
     $sanitize_id = wpinv_sanitize_key( $args['id'] );
 
-	$std     = isset( $args['std'] ) ? $args['std'] : '';
-	$value   = wpinv_get_option( $args['id'], $std );
+    $std     = isset( $args['std'] ) ? $args['std'] : '';
+    $value   = wpinv_get_option( $args['id'], $std );
 
-	if ( ! empty( $args['allow_blank'] ) && empty( $value ) ) {
-		$value = $std;
-	}
+    if ( ! empty( $args['allow_blank'] ) && empty( $value ) ) {
+        $value = $std;
+    }
 
-	$rows = isset( $args['size'] ) ? $args['size'] : 20;
+    $rows = isset( $args['size'] ) ? $args['size'] : 20;
 
-	echo '<div class="getpaid-settings-editor-input">';
-	if ( $wp_version >= 3.3 && function_exists( 'wp_editor' ) ) {
-		wp_editor(
+    echo '<div class="getpaid-settings-editor-input">';
+    if ( $wp_version >= 3.3 && function_exists( 'wp_editor' ) ) {
+        wp_editor(
             stripslashes( $value ),
             'wpinv_settings_' . esc_attr( $args['id'] ),
             array(
-				'textarea_name' => 'wpinv_settings[' . esc_attr( $args['id'] ) . ']',
-				'textarea_rows' => absint( $rows ),
-				'media_buttons' => false,
+                'textarea_name' => 'wpinv_settings[' . esc_attr( $args['id'] ) . ']',
+                'textarea_rows' => absint( $rows ),
+                'media_buttons' => false,
             )
         );
-	} else {
-		echo '<textarea class="large-text" rows="10" id="wpinv_settings[' . esc_attr( $sanitize_id ) . ']" name="wpinv_settings[' . esc_attr( $args['id'] ) . ']" class="wpi-' . esc_attr( sanitize_html_class( $args['id'] ) ) . '">' . esc_textarea( stripslashes( $value ) ) . '</textarea>';
-	}
+    } else {
+        echo '<textarea class="large-text" rows="10" id="wpinv_settings[' . esc_attr( $sanitize_id ) . ']" name="wpinv_settings[' . esc_attr( $args['id'] ) . ']" class="wpi-' . esc_attr( sanitize_html_class( $args['id'] ) ) . '">' . esc_textarea( stripslashes( $value ) ) . '</textarea>';
+    }
 
-	echo '</div><br/><label for="wpinv_settings[' . esc_attr( $sanitize_id ) . ']"> ' . wp_kses_post( $args['desc'] ) . '</label>';
+    echo '</div><br/><label for="wpinv_settings[' . esc_attr( $sanitize_id ) . ']"> ' . wp_kses_post( $args['desc'] ) . '</label>';
 
 }
 
@@ -893,51 +893,51 @@ 
 
     $sanitize_id = wpinv_sanitize_key( $args['id'] );
 
-	$std     = isset( $args['std'] ) ? $args['std'] : '';
-	$value   = wpinv_get_option( $args['id'], $std );
+    $std     = isset( $args['std'] ) ? $args['std'] : '';
+    $value   = wpinv_get_option( $args['id'], $std );
 
-	$size = ( isset( $args['size'] ) && ! is_null( $args['size'] ) ) ? $args['size'] : 'regular';
-	echo '<input type="text" class="' . sanitize_html_class( $size ) . '-text" id="wpinv_settings[' . esc_attr( $sanitize_id ) . ']" name="wpinv_settings[' . esc_attr( $args['id'] ) . ']" value="' . esc_attr( stripslashes( $value ) ) . '"/>';
-	echo '<span>&nbsp;<input type="button" class="wpinv_settings_upload_button button-secondary" value="' . esc_attr__( 'Upload File', 'invoicing' ) . '"/></span>';
-	echo '<label for="wpinv_settings[' . esc_attr( $sanitize_id ) . ']"> ' . wp_kses_post( $args['desc'] ) . '</label>';
+    $size = ( isset( $args['size'] ) && ! is_null( $args['size'] ) ) ? $args['size'] : 'regular';
+    echo '<input type="text" class="' . sanitize_html_class( $size ) . '-text" id="wpinv_settings[' . esc_attr( $sanitize_id ) . ']" name="wpinv_settings[' . esc_attr( $args['id'] ) . ']" value="' . esc_attr( stripslashes( $value ) ) . '"/>';
+    echo '<span>&nbsp;<input type="button" class="wpinv_settings_upload_button button-secondary" value="' . esc_attr__( 'Upload File', 'invoicing' ) . '"/></span>';
+    echo '<label for="wpinv_settings[' . esc_attr( $sanitize_id ) . ']"> ' . wp_kses_post( $args['desc'] ) . '</label>';
 
 }
 
 function wpinv_color_callback( $args ) {
 
-	$std         = isset( $args['std'] ) ? $args['std'] : '';
-	$value       = wpinv_get_option( $args['id'], $std );
+    $std         = isset( $args['std'] ) ? $args['std'] : '';
+    $value       = wpinv_get_option( $args['id'], $std );
     $sanitize_id = wpinv_sanitize_key( $args['id'] );
 
-	echo '<input type="text" class="wpinv-color-picker" id="wpinv_settings[' . esc_attr( $sanitize_id ) . ']" name="wpinv_settings[' . esc_attr( $args['id'] ) . ']" value="' . esc_attr( $value ) . '" data-default-color="' . esc_attr( $std ) . '" />';
-	echo '<label for="wpinv_settings[' . esc_attr( $sanitize_id ) . ']"> ' . wp_kses_post( $args['desc'] ) . '</label>';
+    echo '<input type="text" class="wpinv-color-picker" id="wpinv_settings[' . esc_attr( $sanitize_id ) . ']" name="wpinv_settings[' . esc_attr( $args['id'] ) . ']" value="' . esc_attr( $value ) . '" data-default-color="' . esc_attr( $std ) . '" />';
+    echo '<label for="wpinv_settings[' . esc_attr( $sanitize_id ) . ']"> ' . wp_kses_post( $args['desc'] ) . '</label>';
 
 }
 
 function wpinv_country_states_callback( $args ) {
 
-	$std     = isset( $args['std'] ) ? $args['std'] : '';
-	$value   = wpinv_get_option( $args['id'], $std );
+    $std     = isset( $args['std'] ) ? $args['std'] : '';
+    $value   = wpinv_get_option( $args['id'], $std );
 
     $sanitize_id = wpinv_sanitize_key( $args['id'] );
 
-	if ( isset( $args['placeholder'] ) ) {
-		$placeholder = $args['placeholder'];
-	} else {
-		$placeholder = '';
-	}
+    if ( isset( $args['placeholder'] ) ) {
+        $placeholder = $args['placeholder'];
+    } else {
+        $placeholder = '';
+    }
 
-	$states = wpinv_get_country_states();
+    $states = wpinv_get_country_states();
 
-	$class = empty( $states ) ? 'wpinv-no-states' : 'wpi_select2';
-	echo '<select id="wpinv_settings[' . esc_attr( $sanitize_id ) . ']" name="wpinv_settings[' . esc_attr( $args['id'] ) . ']" class="' . esc_attr( $class ) . '" data-placeholder="' . esc_html( $placeholder ) . '"/>';
+    $class = empty( $states ) ? 'wpinv-no-states' : 'wpi_select2';
+    echo '<select id="wpinv_settings[' . esc_attr( $sanitize_id ) . ']" name="wpinv_settings[' . esc_attr( $args['id'] ) . ']" class="' . esc_attr( $class ) . '" data-placeholder="' . esc_html( $placeholder ) . '"/>';
 
-	foreach ( $states as $option => $name ) {
-		echo '<option value="' . esc_attr( $option ) . '" ' . selected( $option, $value ) . '>' . esc_html( $name ) . '</option>';
-	}
+    foreach ( $states as $option => $name ) {
+        echo '<option value="' . esc_attr( $option ) . '" ' . selected( $option, $value ) . '>' . esc_html( $name ) . '</option>';
+    }
 
-	echo '</select>';
-	echo '<label for="wpinv_settings[' . esc_attr( $sanitize_id ) . ']"> ' . wp_kses_post( $args['desc'] ) . '</label>';
+    echo '</select>';
+    echo '<label for="wpinv_settings[' . esc_attr( $sanitize_id ) . ']"> ' . wp_kses_post( $args['desc'] ) . '</label>';
 
 }
 
@@ -946,7 +946,7 @@ 
  */
 function wpinv_tax_rates_callback() {
 
-	?>
+    ?>
 		</td>
 	</tr>
 	<tr class="bsui">
@@ -962,9 +962,9 @@ 
  */
 function wpinv_tax_rate_callback( $tax_rate, $key ) {
 
-	$key                      = sanitize_key( $key );
-	$tax_rate['reduced_rate'] = empty( $tax_rate['reduced_rate'] ) ? 0 : $tax_rate['reduced_rate'];
-	include plugin_dir_path( __FILE__ ) . 'views/html-tax-rate-edit.php';
+    $key                      = sanitize_key( $key );
+    $tax_rate['reduced_rate'] = empty( $tax_rate['reduced_rate'] ) ? 0 : $tax_rate['reduced_rate'];
+    include plugin_dir_path( __FILE__ ) . 'views/html-tax-rate-edit.php';
 
 }
 
@@ -973,7 +973,7 @@ 
  */
 function wpinv_tax_rules_callback() {
 
-	?>
+    ?>
 		</td>
 	</tr>
 	<tr class="bsui">
@@ -1011,14 +1011,14 @@ 
                 <td>
 					<a href="
                     <?php
-						echo esc_url(
-							wp_nonce_url(
-								add_query_arg( 'getpaid-admin-action', 'create_missing_pages' ),
-								'getpaid-nonce',
-								'getpaid-nonce'
-							)
-						);
-					?>
+                        echo esc_url(
+                            wp_nonce_url(
+                                add_query_arg( 'getpaid-admin-action', 'create_missing_pages' ),
+                                'getpaid-nonce',
+                                'getpaid-nonce'
+                            )
+                        );
+                    ?>
                     " class="button button-primary"><?php esc_html_e( 'Run', 'invoicing' ); ?></a>
                 </td>
             </tr>
@@ -1030,14 +1030,14 @@ 
                 <td>
 					<a href="
                     <?php
-						echo esc_url(
-							wp_nonce_url(
-								add_query_arg( 'getpaid-admin-action', 'refresh_permalinks' ),
-								'getpaid-nonce',
-								'getpaid-nonce'
-							)
-						);
-					?>
+                        echo esc_url(
+                            wp_nonce_url(
+                                add_query_arg( 'getpaid-admin-action', 'refresh_permalinks' ),
+                                'getpaid-nonce',
+                                'getpaid-nonce'
+                            )
+                        );
+                    ?>
                     " class="button button-primary"><?php esc_html_e( 'Run', 'invoicing' ); ?></a>
                 </td>
             </tr>
@@ -1049,14 +1049,14 @@ 
                 <td>
 					<a href="
                     <?php
-						echo esc_url(
-							wp_nonce_url(
-								add_query_arg( 'getpaid-admin-action', 'create_missing_tables' ),
-								'getpaid-nonce',
-								'getpaid-nonce'
-							)
-						);
-					?>
+                        echo esc_url(
+                            wp_nonce_url(
+                                add_query_arg( 'getpaid-admin-action', 'create_missing_tables' ),
+                                'getpaid-nonce',
+                                'getpaid-nonce'
+                            )
+                        );
+                    ?>
                     " class="button button-primary"><?php esc_html_e( 'Run', 'invoicing' ); ?></a>
                 </td>
             </tr>
@@ -1068,14 +1068,14 @@ 
                 <td>
 					<a href="
                     <?php
-						echo esc_url(
-							wp_nonce_url(
-								add_query_arg( 'getpaid-admin-action', 'migrate_old_invoices' ),
-								'getpaid-nonce',
-								'getpaid-nonce'
-							)
-						);
-					?>
+                        echo esc_url(
+                            wp_nonce_url(
+                                add_query_arg( 'getpaid-admin-action', 'migrate_old_invoices' ),
+                                'getpaid-nonce',
+                                'getpaid-nonce'
+                            )
+                        );
+                    ?>
                     " class="button button-primary"><?php esc_html_e( 'Run', 'invoicing' ); ?></a>
                 </td>
             </tr>
@@ -1088,14 +1088,14 @@ 
                 <td>
 					<a href="
                     <?php
-						echo esc_url(
-							wp_nonce_url(
-								add_query_arg( 'getpaid-admin-action', 'recalculate_discounts' ),
-								'getpaid-nonce',
-								'getpaid-nonce'
-							)
-						);
-					?>
+                        echo esc_url(
+                            wp_nonce_url(
+                                add_query_arg( 'getpaid-admin-action', 'recalculate_discounts' ),
+                                'getpaid-nonce',
+                                'getpaid-nonce'
+                            )
+                        );
+                    ?>
                     " class="button button-primary"><?php esc_html_e( 'Run', 'invoicing' ); ?></a>
                 </td>
             </tr>
@@ -1108,8 +1108,8 @@ 
                 <td>
 					<a href="
                     <?php
-						echo esc_url( admin_url( 'index.php?page=gp-setup' ) );
-					?>
+                        echo esc_url( admin_url( 'index.php?page=gp-setup' ) );
+                    ?>
                     " class="button button-primary"><?php esc_html_e( 'Launch', 'invoicing' ); ?></a>
                 </td>
             </tr>
@@ -1123,19 +1123,19 @@ 
 
 
 function wpinv_descriptive_text_callback( $args ) {
-	echo wp_kses_post( $args['desc'] );
+    echo wp_kses_post( $args['desc'] );
 }
 
 function wpinv_raw_html_callback( $args ) {
-	echo wp_kses( $args['desc'], getpaid_allowed_html() );
+    echo wp_kses( $args['desc'], getpaid_allowed_html() );
 }
 
 function wpinv_hook_callback( $args ) {
-	do_action( 'wpinv_' . $args['id'], $args );
+    do_action( 'wpinv_' . $args['id'], $args );
 }
 
 function wpinv_set_settings_cap() {
-	return wpinv_get_capability();
+    return wpinv_get_capability();
 }
 add_filter( 'option_page_capability_wpinv_settings', 'wpinv_set_settings_cap' );
 
@@ -1161,47 +1161,47 @@ 
  * @return array
  */
 function wpinv_get_email_merge_tags( $subscription = false ) {
-	$merge_tags = array(
-		'{site_title}'           => __( 'Site Title', 'invoicing' ),
-		'{name}'                 => __( "Customer's full name", 'invoicing' ),
-		'{first_name}'           => __( "Customer's first name", 'invoicing' ),
-		'{last_name}'            => __( "Customer's last name", 'invoicing' ),
-		'{email}'                => __( "Customer's email address", 'invoicing' ),
-		'{invoice_number}'       => __( 'The invoice number', 'invoicing' ),
-		'{invoice_currency}'     => __( 'The invoice currency', 'invoicing' ),
-		'{invoice_total}'        => __( 'The invoice total', 'invoicing' ),
-		'{invoice_link}'         => __( 'The invoice link', 'invoicing' ),
-		'{invoice_pay_link}'     => __( 'The payment link', 'invoicing' ),
-		'{invoice_receipt_link}' => __( 'The receipt link', 'invoicing' ),
-		'{invoice_date}'         => __( 'The date the invoice was created', 'invoicing' ),
-		'{invoice_due_date}'     => __( 'The date the invoice is due', 'invoicing' ),
-		'{date}'                 => __( "Today's date", 'invoicing' ),
-		'{is_was}'               => __( 'If due date of invoice is past, displays "was" otherwise displays "is"', 'invoicing' ),
-		'{invoice_label}'        => __( 'Invoices/quotes singular name. Ex: Invoice/Quote', 'invoicing' ),
-		'{invoice_quote}'        => __( 'Invoices/quotes singular name in small letters. Ex: invoice/quote', 'invoicing' ),
-		'{invoice_description}'  => __( 'The description of the invoice', 'invoicing' ),
-	);
-
-	if ( $subscription ) {
-		$merge_tags = array_merge(
-			$merge_tags,
-			array(
-				'{subscription_renewal_date}'     => __( 'The next renewal date of the subscription', 'invoicing' ),
-				'{subscription_created}'          => __( "The subscription's creation date", 'invoicing' ),
-				'{subscription_status}'           => __( "The subscription's status", 'invoicing' ),
-				'{subscription_profile_id}'       => __( "The subscription's remote profile id", 'invoicing' ),
-				'{subscription_id}'               => __( "The subscription's id", 'invoicing' ),
-				'{subscription_recurring_amount}' => __( 'The renewal amount of the subscription', 'invoicing' ),
-				'{subscription_initial_amount}'   => __( 'The initial amount of the subscription', 'invoicing' ),
-				'{subscription_recurring_period}' => __( 'The recurring period of the subscription (e.g 1 year)', 'invoicing' ),
-				'{subscription_bill_times}'       => __( 'The maximum number of times the subscription can be renewed', 'invoicing' ),
-				'{subscription_url}'              => __( 'The URL to manage a subscription', 'invoicing' ),
-				'{subscription_name}'             => __( 'The name of the recurring item', 'invoicing' ),
-			)
-		);
-	}
-
-	return $merge_tags;
+    $merge_tags = array(
+        '{site_title}'           => __( 'Site Title', 'invoicing' ),
+        '{name}'                 => __( "Customer's full name", 'invoicing' ),
+        '{first_name}'           => __( "Customer's first name", 'invoicing' ),
+        '{last_name}'            => __( "Customer's last name", 'invoicing' ),
+        '{email}'                => __( "Customer's email address", 'invoicing' ),
+        '{invoice_number}'       => __( 'The invoice number', 'invoicing' ),
+        '{invoice_currency}'     => __( 'The invoice currency', 'invoicing' ),
+        '{invoice_total}'        => __( 'The invoice total', 'invoicing' ),
+        '{invoice_link}'         => __( 'The invoice link', 'invoicing' ),
+        '{invoice_pay_link}'     => __( 'The payment link', 'invoicing' ),
+        '{invoice_receipt_link}' => __( 'The receipt link', 'invoicing' ),
+        '{invoice_date}'         => __( 'The date the invoice was created', 'invoicing' ),
+        '{invoice_due_date}'     => __( 'The date the invoice is due', 'invoicing' ),
+        '{date}'                 => __( "Today's date", 'invoicing' ),
+        '{is_was}'               => __( 'If due date of invoice is past, displays "was" otherwise displays "is"', 'invoicing' ),
+        '{invoice_label}'        => __( 'Invoices/quotes singular name. Ex: Invoice/Quote', 'invoicing' ),
+        '{invoice_quote}'        => __( 'Invoices/quotes singular name in small letters. Ex: invoice/quote', 'invoicing' ),
+        '{invoice_description}'  => __( 'The description of the invoice', 'invoicing' ),
+    );
+
+    if ( $subscription ) {
+        $merge_tags = array_merge(
+            $merge_tags,
+            array(
+                '{subscription_renewal_date}'     => __( 'The next renewal date of the subscription', 'invoicing' ),
+                '{subscription_created}'          => __( "The subscription's creation date", 'invoicing' ),
+                '{subscription_status}'           => __( "The subscription's status", 'invoicing' ),
+                '{subscription_profile_id}'       => __( "The subscription's remote profile id", 'invoicing' ),
+                '{subscription_id}'               => __( "The subscription's id", 'invoicing' ),
+                '{subscription_recurring_amount}' => __( 'The renewal amount of the subscription', 'invoicing' ),
+                '{subscription_initial_amount}'   => __( 'The initial amount of the subscription', 'invoicing' ),
+                '{subscription_recurring_period}' => __( 'The recurring period of the subscription (e.g 1 year)', 'invoicing' ),
+                '{subscription_bill_times}'       => __( 'The maximum number of times the subscription can be renewed', 'invoicing' ),
+                '{subscription_url}'              => __( 'The URL to manage a subscription', 'invoicing' ),
+                '{subscription_name}'             => __( 'The name of the recurring item', 'invoicing' ),
+            )
+        );
+    }
+
+    return $merge_tags;
 }
 
 
@@ -1213,28 +1213,28 @@ 
  * @return string
  */
 function wpinv_get_merge_tags_help_text( $subscription = false ) {
-	$merge_tags = wpinv_get_email_merge_tags( $subscription );
+    $merge_tags = wpinv_get_email_merge_tags( $subscription );
 
-	$output = '<div class="bsui">';
+    $output = '<div class="bsui">';
 
-	$link = sprintf(
-		'<strong class="getpaid-merge-tags text-primary" role="button">%s</strong>',
-		esc_html__( 'View available merge tags.', 'invoicing' )
-	);
+    $link = sprintf(
+        '<strong class="getpaid-merge-tags text-primary" role="button">%s</strong>',
+        esc_html__( 'View available merge tags.', 'invoicing' )
+    );
 
-	$description = esc_html__( 'The content of the email (Merge Tags and HTML are allowed).', 'invoicing' );
+    $description = esc_html__( 'The content of the email (Merge Tags and HTML are allowed).', 'invoicing' );
 	
-	$output .= "$description $link";
+    $output .= "$description $link";
 
-	$output .= '<div class="getpaid-merge-tags-content mt-2 p-1 d-none">';
-	$output .= '<p class="mb-2">' . esc_html__( 'The following wildcards can be used in email subjects, heading and content:', 'invoicing' ) . '</p>';
+    $output .= '<div class="getpaid-merge-tags-content mt-2 p-1 d-none">';
+    $output .= '<p class="mb-2">' . esc_html__( 'The following wildcards can be used in email subjects, heading and content:', 'invoicing' ) . '</p>';
 
-	$output .= '<ul class="p-0 m-0">';
-	foreach($merge_tags as $tag => $tag_description) {
-		$output .= "<li class='mb-2'><strong class='text-dark'>$tag</strong> &mdash; $tag_description</li>";
-	}
+    $output .= '<ul class="p-0 m-0">';
+    foreach($merge_tags as $tag => $tag_description) {
+        $output .= "<li class='mb-2'><strong class='text-dark'>$tag</strong> &mdash; $tag_description</li>";
+    }
 
-	$output .= '</ul></div></div>';
+    $output .= '</ul></div></div>';
 
-	return $output;
+    return $output;
 }

includes/api/class-getpaid-rest-date-based-controller.php

Indentation +491 added lines, -491 removed lines

@@ -16,496 +16,496 @@
  */
 class GetPaid_REST_Date_Based_Controller extends GetPaid_REST_Controller {
 
-	/**
-	 * Group response items by day or month.
-	 *
-	 * @var string
-	 */
-	public $groupby = 'day';
-
-	/**
-	 * Returns an array with arguments to request the previous report.
-	 *
-	 * @var array
-	 */
-	public $previous_range = array();
-
-	/**
-	 * The period interval.
-	 *
-	 * @var int
-	 */
-	public $interval;
-
-	/**
-	 * Retrieves the before and after dates.
-	 *
-	 * @param WP_REST_Request $request Request object.
-	 * @return array The appropriate date range.
-	 */
-	public function get_date_range( $request ) {
-
-		// Check if the period is x_days.
-		if ( preg_match( '/^(\d+)_days$/', $request['period'], $matches ) ) {
-			$date_range = $this->get_x_days_date_range( absint( $matches[1] ) );
-		} elseif ( is_callable( array( $this, 'get_' . $request['period'] . '_date_range' ) ) ) {
-			$date_range = call_user_func( array( $this, 'get_' . $request['period'] . '_date_range' ), $request );
-		} else {
-			$request['period'] = '7_days';
-			$date_range        = $this->get_x_days_date_range();
-		}
-
-		// 3 months max for day view.
-		$before = strtotime( $date_range['before'] );
-		$after  = strtotime( $date_range['after'] );
-		if ( floor( ( $before - $after ) / MONTH_IN_SECONDS ) > 2 ) {
-			$this->groupby = 'month';
-		}
-
-		$this->prepare_interval( $date_range );
-
-		return $date_range;
-
-	}
-
-	/**
-	 * Groups by month or days.
-	 *
-	 * @param array $range Date range.
-	 * @return array The appropriate date range.
-	 */
-	public function prepare_interval( $range ) {
-
-		$before = strtotime( $range['before'] );
-		$after  = strtotime( $range['after'] );
-		if ( 'day' === $this->groupby ) {
-			$difference     = max( DAY_IN_SECONDS, ( DAY_IN_SECONDS + $before - $after ) ); // Prevent division by 0;
-			$this->interval = absint( ceil( max( 1, $difference / DAY_IN_SECONDS ) ) );
-			return;
-		}
-
-		$this->interval = 0;
-		$min_date       = strtotime( gmdate( 'Y-m-01', $after ) );
-
-		while ( $min_date <= $before ) {
-			$this->interval ++;
-			$min_date = strtotime( '+1 MONTH', $min_date );
-		}
-
-		$this->interval = max( 1, $this->interval );
-
-	}
-
-	/**
-	 * Retrieves a custom date range.
-	 *
-	 * @param WP_REST_Request $request Request object.
-	 * @return array The appropriate date range.
-	 */
-	public function get_custom_date_range( $request ) {
-
-		$after  = max( strtotime( '-20 years' ), strtotime( sanitize_text_field( $request['after'] ) ) );
-		$before = gmdate( 'Y-m-d' );
+    /**
+     * Group response items by day or month.
+     *
+     * @var string
+     */
+    public $groupby = 'day';
+
+    /**
+     * Returns an array with arguments to request the previous report.
+     *
+     * @var array
+     */
+    public $previous_range = array();
+
+    /**
+     * The period interval.
+     *
+     * @var int
+     */
+    public $interval;
+
+    /**
+     * Retrieves the before and after dates.
+     *
+     * @param WP_REST_Request $request Request object.
+     * @return array The appropriate date range.
+     */
+    public function get_date_range( $request ) {
+
+        // Check if the period is x_days.
+        if ( preg_match( '/^(\d+)_days$/', $request['period'], $matches ) ) {
+            $date_range = $this->get_x_days_date_range( absint( $matches[1] ) );
+        } elseif ( is_callable( array( $this, 'get_' . $request['period'] . '_date_range' ) ) ) {
+            $date_range = call_user_func( array( $this, 'get_' . $request['period'] . '_date_range' ), $request );
+        } else {
+            $request['period'] = '7_days';
+            $date_range        = $this->get_x_days_date_range();
+        }
+
+        // 3 months max for day view.
+        $before = strtotime( $date_range['before'] );
+        $after  = strtotime( $date_range['after'] );
+        if ( floor( ( $before - $after ) / MONTH_IN_SECONDS ) > 2 ) {
+            $this->groupby = 'month';
+        }
+
+        $this->prepare_interval( $date_range );
+
+        return $date_range;
+
+    }
+
+    /**
+     * Groups by month or days.
+     *
+     * @param array $range Date range.
+     * @return array The appropriate date range.
+     */
+    public function prepare_interval( $range ) {
+
+        $before = strtotime( $range['before'] );
+        $after  = strtotime( $range['after'] );
+        if ( 'day' === $this->groupby ) {
+            $difference     = max( DAY_IN_SECONDS, ( DAY_IN_SECONDS + $before - $after ) ); // Prevent division by 0;
+            $this->interval = absint( ceil( max( 1, $difference / DAY_IN_SECONDS ) ) );
+            return;
+        }
+
+        $this->interval = 0;
+        $min_date       = strtotime( gmdate( 'Y-m-01', $after ) );
+
+        while ( $min_date <= $before ) {
+            $this->interval ++;
+            $min_date = strtotime( '+1 MONTH', $min_date );
+        }
+
+        $this->interval = max( 1, $this->interval );
+
+    }
+
+    /**
+     * Retrieves a custom date range.
+     *
+     * @param WP_REST_Request $request Request object.
+     * @return array The appropriate date range.
+     */
+    public function get_custom_date_range( $request ) {
+
+        $after  = max( strtotime( '-20 years' ), strtotime( sanitize_text_field( $request['after'] ) ) );
+        $before = gmdate( 'Y-m-d' );
 		
-		if ( ! empty( $request['before'] ) ) {
-			$before  = min( strtotime( $before ), strtotime( sanitize_text_field( $request['before'] ) ) );
-		}
-
-		// Set the previous date range.
-		$difference           = $before - $after;
-		$this->previous_range = array(
-			'period' => 'custom',
-			'before' => gmdate( 'Y-m-d', $before - $difference - DAY_IN_SECONDS ),
-			'after'  => gmdate( 'Y-m-d', $after - $difference - DAY_IN_SECONDS ),
-		);
-
-		// Generate the report.
-		return array(
-			'before' => gmdate( 'Y-m-d', $before ),
-			'after'  => gmdate( 'Y-m-d', $after ),
-		);
-
-	}
-
-	/**
-	 * Retrieves todays date range.
-	 *
-	 * @return array The appropriate date range.
-	 */
-	public function get_today_date_range() {
-
-		// Set the previous date range.
-		$this->previous_range = array(
-			'period' => 'yesterday',
-		);
-
-		// Generate the report.
-		return array(
-			'before' => gmdate( 'Y-m-d' ),
-			'after'  => gmdate( 'Y-m-d' ),
-		);
-
-	}
-
-	/**
-	 * Retrieves yesterdays date range.
-	 *
-	 * @return array The appropriate date range.
-	 */
-	public function get_yesterday_date_range() {
-
-		// Set the previous date range.
-		$this->previous_range = array(
-			'period' => 'custom',
-			'before' => gmdate( 'Y-m-d', strtotime( '-2 days' ) ),
-			'after'  => gmdate( 'Y-m-d', strtotime( '-2 days' ) ),
-		);
-
-		// Generate the report.
-		return array(
-			'before' => gmdate( 'Y-m-d', strtotime( '-1 day' ) ),
-			'after'  => gmdate( 'Y-m-d', strtotime( '-1 day' ) ),
-		);
-
-	}
-
-	/**
-	 * Retrieves this week's date range.
-	 *
-	 * @return array The appropriate date range.
-	 */
-	public function get_week_date_range() {
-
-		// Set the previous date range.
-		$this->previous_range = array(
-			'period' => 'last_week',
-		);
-
-		// Generate the report.
-		$week_starts = absint( get_option( 'start_of_week' ) );
-		return array(
-			'before' => gmdate( 'Y-m-d' ),
-			'after'  => gmdate( 'Y-m-d', strtotime( 'next Sunday -' . ( 7 - $week_starts ) . ' days' ) ),
-		);
-	}
-
-	/**
-	 * Retrieves last week's date range.
-	 *
-	 * @return array The appropriate date range.
-	 */
-	public function get_last_week_date_range() {
-
-		$week_starts = absint( get_option( 'start_of_week' ) );
-		$week_starts = strtotime( 'last Sunday -' . ( 7 - $week_starts ) . ' days' );
-		$date_range  = array(
-			'before' => gmdate( 'Y-m-d', $week_starts + 6 * DAY_IN_SECONDS ),
-			'after'  => gmdate( 'Y-m-d', $week_starts ),
-		);
-
-		// Set the previous date range.
-		$week_starts          = $week_starts - 7 * DAY_IN_SECONDS;
-		$this->previous_range = array(
-			'period' => 'custom',
-			'before' => gmdate( 'Y-m-d', $week_starts + 6 * DAY_IN_SECONDS ),
-			'after'  => gmdate( 'Y-m-d', $week_starts ),
-		);
-
-		// Generate the report.
-		return $date_range;
-	}
-
-	/**
-	 * Retrieves last x days date range.
-	 *
-	 * @return array The appropriate date range.
-	 */
-	public function get_x_days_date_range( $days = 7 ) {
-
-		$days--;
-
-		$date_range  = array(
-			'before' => gmdate( 'Y-m-d' ),
-			'after'  => gmdate( 'Y-m-d', strtotime( "-$days days" ) ),
-		);
-
-		$days++;
-
-		// Set the previous date range.
-		$this->previous_range = array(
-			'period' => 'custom',
-			'before' => gmdate( 'Y-m-d', strtotime( $date_range['before'] ) - $days * DAY_IN_SECONDS ),
-			'after'  => gmdate( 'Y-m-d', strtotime( $date_range['after'] ) - $days * DAY_IN_SECONDS ),
-		);
-
-		// Generate the report.
-		return $date_range;
-	}
-
-	/**
-	 * Retrieves this month date range.
-	 *
-	 * @return array The appropriate date range.
-	 */
-	public function get_month_date_range() {
-
-		// Set the previous date range.
-		$this->previous_range = array(
-			'period' => 'last_month',
-		);
-
-		// Generate the report.
-		return array(
-			'after'  => gmdate( 'Y-m-01' ),
-			'before' => gmdate( 'Y-m-t' ),
-		);
-
-	}
-
-	/**
-	 * Retrieves last month's date range.
-	 *
-	 * @return array The appropriate date range.
-	 */
-	public function get_last_month_date_range() {
-
-		// Set the previous date range.
-		$this->previous_range = array(
-			'period' => 'custom',
-			'after'  => gmdate( 'Y-m-01', strtotime( '-2 months' ) ),
-			'before' => gmdate( 'Y-m-t', strtotime( '-2 months' ) ),
-		);
-
-		// Generate the report.
-		return array(
-			'after'  => gmdate( 'Y-m-01', strtotime( 'last month' ) ),
-			'before' => gmdate( 'Y-m-t', strtotime( 'last month' ) ),
-		);
-
-	}
-
-	/**
-	 * Retrieves this quarter date range.
-	 *
-	 * @return array The available quarters.
-	 */
-	public function get_quarters() {
-
-		$year      = (int) gmdate( 'Y' );
-		$last_year = (int) $year - 1;
-		return array(
-
-			// Third quarter of previous year: July 1st to September 30th
-			array(
-				'before' => "{$last_year}-09-30",
-				'after'  => "{$last_year}-07-01",
-			),
-
-			// Last quarter of previous year: October 1st to December 31st
-			array(
-				'before' => "{$last_year}-12-31",
-        		'after'  => "{$last_year}-10-01",
-			),
-
-			// First quarter: January 1st to March 31st
-			array(
-				'before' => "{$year}-03-31",
-				'after'  => "{$year}-01-01",
-			),
-
-			// Second quarter: April 1st to June 30th
-			array(
-				'before' => "{$year}-06-30",
-				'after'  => "{$year}-04-01",
-			),
-
-			// Third quarter: July 1st to September 30th
-			array(
-				'before' => "{$year}-09-30",
-				'after'  => "{$year}-07-01",
-			),
-
-			// Fourth quarter: October 1st to December 31st
-			array(
-				'before' => "{$year}-12-31",
-				'after'  => "{$year}-10-01",
-			),
-		);
-	}
-
-	/**
-	 * Retrieves the current quater.
-	 *
-	 * @return int The current quarter.
-	 */
-	public function get_quarter() {
-
-		$month    = (int) gmdate( 'n' );
-		$quarters = array( 1, 1, 1, 2, 2, 2, 3, 3, 3, 4, 4, 4 );
-		return $quarters[ $month - 1 ];
-
-	}
-
-	/**
-	 * Retrieves this quarter date range.
-	 *
-	 * @return array The appropriate date range.
-	 */
-	public function get_quarter_date_range() {
-
-		// Set the previous date range.
-		$this->previous_range = array(
-			'period' => 'last_quarter',
-		);
-
-		// Generate the report.
-		$quarter  = $this->get_quarter();
-		$quarters = $this->get_quarters();
-		return $quarters[ $quarter + 1 ];
-
-	}
-
-	/**
-	 * Retrieves last quarter's date range.
-	 *
-	 * @return array The appropriate date range.
-	 */
-	public function get_last_quarter_date_range() {
-
-		$quarters = $this->get_quarters();
-		$quarter  = $this->get_quarter();
-
-		// Set the previous date range.
-		$this->previous_range = array_merge(
-			$quarters[ $quarter - 1 ],
-			array( 'period' => 'custom' )
-		);
-
-		// Generate the report.
-		return $quarters[ $quarter ];
-
-	}
-
-	/**
-	 * Retrieves this year date range.
-	 *
-	 * @return array The appropriate date range.
-	 */
-	public function get_year_date_range() {
-
-		// Set the previous date range.
-		$this->previous_range = array(
-			'period' => 'last_year',
-		);
-
-		// Generate the report.
-		return array(
-			'after'  => gmdate( 'Y-01-01' ),
-			'before' => gmdate( 'Y-12-31' ),
-		);
-
-	}
-
-	/**
-	 * Retrieves last year date range.
-	 *
-	 * @return array The appropriate date range.
-	 */
-	public function get_last_year_date_range() {
-
-		// Set the previous date range.
-		$this->previous_range = array(
-			'period' => 'custom',
-			'after'  => gmdate( 'Y-01-01', strtotime( '-2 years' ) ),
-			'before' => gmdate( 'Y-12-31', strtotime( '-2 years' ) ),
-		);
-
-		// Generate the report.
-		return array(
-			'after'  => gmdate( 'Y-01-01', strtotime( 'last year' ) ),
-			'before' => gmdate( 'Y-12-31', strtotime( 'last year' ) ),
-		);
-
-	}
-
-	/**
-	 * Prepare a the request date for SQL usage.
-	 *
-	 * @param WP_REST_Request $request Request object.
-	 * @param string $date_field The date field.
-	 * @return string The appropriate SQL.
-	 */
-	public function get_date_range_sql( $request, $date_field ) {
-		global $wpdb;
-
-		$sql = '1=1';
-		$range = $this->get_date_range( $request );
-
-		if ( ! empty( $range['after'] ) ) {
-			$sql .= ' AND ' . $wpdb->prepare(
-				"$date_field >= %s",
-				$range['after']
-			);
-		}
-
-		if ( ! empty( $range['before'] ) ) {
-			$sql .= ' AND ' . $wpdb->prepare(
-				"$date_field <= %s",
-				$range['before']
-			);
-		}
-
-		return $sql;
-
-	}
-
-	/**
-	 * Prepares a group by query.
-	 *
-	 * @param string $date_field The date field.
-	 * @return string The appropriate SQL.
-	 */
-	public function get_group_by_sql( $date_field ) {
-
-		if ( 'day' === $this->groupby ) {
-			return "YEAR($date_field), MONTH($date_field), DAY($date_field)";
-		}
-
-		return "YEAR($date_field), MONTH($date_field)";
-	}
-
-	/**
-	 * Get the query params for collections.
-	 *
-	 * @return array
-	 */
-	public function get_collection_params() {
-		return array(
-			'context' => $this->get_context_param( array( 'default' => 'view' ) ),
-			'period'  => array(
-				'description'       => __( 'Limit to results of a specific period.', 'invoicing' ),
-				'type'              => 'string',
-				'enum'              => array( 'custom', 'today', 'yesterday', 'week', 'last_week', '7_days', '30_days', '60_days', '90_days', '180_days', 'month', 'last_month', 'quarter', 'last_quarter', 'year', 'last_year', 'quarter', 'last_quarter' ),
-				'validate_callback' => 'rest_validate_request_arg',
-				'sanitize_callback' => 'sanitize_text_field',
-				'default'           => '7_days',
-			),
-			'after'   => array(
-				/* translators: %s: date format */
-				'description'       => sprintf( __( 'Limit to results after a specific date, the date needs to be in the %s format.', 'invoicing' ), 'YYYY-MM-DD' ),
-				'type'              => 'string',
-				'validate_callback' => 'rest_validate_request_arg',
-				'sanitize_callback' => 'sanitize_text_field',
-				'default'           => gmdate( 'Y-m-d', strtotime( '-7 days' ) ),
-			),
-			'before'  => array(
-				/* translators: %s: date format */
-				'description'       => sprintf( __( 'Limit to results before a specific date, the date needs to be in the %s format.', 'invoicing' ), 'YYYY-MM-DD' ),
-				'type'              => 'string',
-				'validate_callback' => 'rest_validate_request_arg',
-				'sanitize_callback' => 'sanitize_text_field',
-				'default'           => gmdate( 'Y-m-d' ),
-			),
-		);
-	}
+        if ( ! empty( $request['before'] ) ) {
+            $before  = min( strtotime( $before ), strtotime( sanitize_text_field( $request['before'] ) ) );
+        }
+
+        // Set the previous date range.
+        $difference           = $before - $after;
+        $this->previous_range = array(
+            'period' => 'custom',
+            'before' => gmdate( 'Y-m-d', $before - $difference - DAY_IN_SECONDS ),
+            'after'  => gmdate( 'Y-m-d', $after - $difference - DAY_IN_SECONDS ),
+        );
+
+        // Generate the report.
+        return array(
+            'before' => gmdate( 'Y-m-d', $before ),
+            'after'  => gmdate( 'Y-m-d', $after ),
+        );
+
+    }
+
+    /**
+     * Retrieves todays date range.
+     *
+     * @return array The appropriate date range.
+     */
+    public function get_today_date_range() {
+
+        // Set the previous date range.
+        $this->previous_range = array(
+            'period' => 'yesterday',
+        );
+
+        // Generate the report.
+        return array(
+            'before' => gmdate( 'Y-m-d' ),
+            'after'  => gmdate( 'Y-m-d' ),
+        );
+
+    }
+
+    /**
+     * Retrieves yesterdays date range.
+     *
+     * @return array The appropriate date range.
+     */
+    public function get_yesterday_date_range() {
+
+        // Set the previous date range.
+        $this->previous_range = array(
+            'period' => 'custom',
+            'before' => gmdate( 'Y-m-d', strtotime( '-2 days' ) ),
+            'after'  => gmdate( 'Y-m-d', strtotime( '-2 days' ) ),
+        );
+
+        // Generate the report.
+        return array(
+            'before' => gmdate( 'Y-m-d', strtotime( '-1 day' ) ),
+            'after'  => gmdate( 'Y-m-d', strtotime( '-1 day' ) ),
+        );
+
+    }
+
+    /**
+     * Retrieves this week's date range.
+     *
+     * @return array The appropriate date range.
+     */
+    public function get_week_date_range() {
+
+        // Set the previous date range.
+        $this->previous_range = array(
+            'period' => 'last_week',
+        );
+
+        // Generate the report.
+        $week_starts = absint( get_option( 'start_of_week' ) );
+        return array(
+            'before' => gmdate( 'Y-m-d' ),
+            'after'  => gmdate( 'Y-m-d', strtotime( 'next Sunday -' . ( 7 - $week_starts ) . ' days' ) ),
+        );
+    }
+
+    /**
+     * Retrieves last week's date range.
+     *
+     * @return array The appropriate date range.
+     */
+    public function get_last_week_date_range() {
+
+        $week_starts = absint( get_option( 'start_of_week' ) );
+        $week_starts = strtotime( 'last Sunday -' . ( 7 - $week_starts ) . ' days' );
+        $date_range  = array(
+            'before' => gmdate( 'Y-m-d', $week_starts + 6 * DAY_IN_SECONDS ),
+            'after'  => gmdate( 'Y-m-d', $week_starts ),
+        );
+
+        // Set the previous date range.
+        $week_starts          = $week_starts - 7 * DAY_IN_SECONDS;
+        $this->previous_range = array(
+            'period' => 'custom',
+            'before' => gmdate( 'Y-m-d', $week_starts + 6 * DAY_IN_SECONDS ),
+            'after'  => gmdate( 'Y-m-d', $week_starts ),
+        );
+
+        // Generate the report.
+        return $date_range;
+    }
+
+    /**
+     * Retrieves last x days date range.
+     *
+     * @return array The appropriate date range.
+     */
+    public function get_x_days_date_range( $days = 7 ) {
+
+        $days--;
+
+        $date_range  = array(
+            'before' => gmdate( 'Y-m-d' ),
+            'after'  => gmdate( 'Y-m-d', strtotime( "-$days days" ) ),
+        );
+
+        $days++;
+
+        // Set the previous date range.
+        $this->previous_range = array(
+            'period' => 'custom',
+            'before' => gmdate( 'Y-m-d', strtotime( $date_range['before'] ) - $days * DAY_IN_SECONDS ),
+            'after'  => gmdate( 'Y-m-d', strtotime( $date_range['after'] ) - $days * DAY_IN_SECONDS ),
+        );
+
+        // Generate the report.
+        return $date_range;
+    }
+
+    /**
+     * Retrieves this month date range.
+     *
+     * @return array The appropriate date range.
+     */
+    public function get_month_date_range() {
+
+        // Set the previous date range.
+        $this->previous_range = array(
+            'period' => 'last_month',
+        );
+
+        // Generate the report.
+        return array(
+            'after'  => gmdate( 'Y-m-01' ),
+            'before' => gmdate( 'Y-m-t' ),
+        );
+
+    }
+
+    /**
+     * Retrieves last month's date range.
+     *
+     * @return array The appropriate date range.
+     */
+    public function get_last_month_date_range() {
+
+        // Set the previous date range.
+        $this->previous_range = array(
+            'period' => 'custom',
+            'after'  => gmdate( 'Y-m-01', strtotime( '-2 months' ) ),
+            'before' => gmdate( 'Y-m-t', strtotime( '-2 months' ) ),
+        );
+
+        // Generate the report.
+        return array(
+            'after'  => gmdate( 'Y-m-01', strtotime( 'last month' ) ),
+            'before' => gmdate( 'Y-m-t', strtotime( 'last month' ) ),
+        );
+
+    }
+
+    /**
+     * Retrieves this quarter date range.
+     *
+     * @return array The available quarters.
+     */
+    public function get_quarters() {
+
+        $year      = (int) gmdate( 'Y' );
+        $last_year = (int) $year - 1;
+        return array(
+
+            // Third quarter of previous year: July 1st to September 30th
+            array(
+                'before' => "{$last_year}-09-30",
+                'after'  => "{$last_year}-07-01",
+            ),
+
+            // Last quarter of previous year: October 1st to December 31st
+            array(
+                'before' => "{$last_year}-12-31",
+                'after'  => "{$last_year}-10-01",
+            ),
+
+            // First quarter: January 1st to March 31st
+            array(
+                'before' => "{$year}-03-31",
+                'after'  => "{$year}-01-01",
+            ),
+
+            // Second quarter: April 1st to June 30th
+            array(
+                'before' => "{$year}-06-30",
+                'after'  => "{$year}-04-01",
+            ),
+
+            // Third quarter: July 1st to September 30th
+            array(
+                'before' => "{$year}-09-30",
+                'after'  => "{$year}-07-01",
+            ),
+
+            // Fourth quarter: October 1st to December 31st
+            array(
+                'before' => "{$year}-12-31",
+                'after'  => "{$year}-10-01",
+            ),
+        );
+    }
+
+    /**
+     * Retrieves the current quater.
+     *
+     * @return int The current quarter.
+     */
+    public function get_quarter() {
+
+        $month    = (int) gmdate( 'n' );
+        $quarters = array( 1, 1, 1, 2, 2, 2, 3, 3, 3, 4, 4, 4 );
+        return $quarters[ $month - 1 ];
+
+    }
+
+    /**
+     * Retrieves this quarter date range.
+     *
+     * @return array The appropriate date range.
+     */
+    public function get_quarter_date_range() {
+
+        // Set the previous date range.
+        $this->previous_range = array(
+            'period' => 'last_quarter',
+        );
+
+        // Generate the report.
+        $quarter  = $this->get_quarter();
+        $quarters = $this->get_quarters();
+        return $quarters[ $quarter + 1 ];
+
+    }
+
+    /**
+     * Retrieves last quarter's date range.
+     *
+     * @return array The appropriate date range.
+     */
+    public function get_last_quarter_date_range() {
+
+        $quarters = $this->get_quarters();
+        $quarter  = $this->get_quarter();
+
+        // Set the previous date range.
+        $this->previous_range = array_merge(
+            $quarters[ $quarter - 1 ],
+            array( 'period' => 'custom' )
+        );
+
+        // Generate the report.
+        return $quarters[ $quarter ];
+
+    }
+
+    /**
+     * Retrieves this year date range.
+     *
+     * @return array The appropriate date range.
+     */
+    public function get_year_date_range() {
+
+        // Set the previous date range.
+        $this->previous_range = array(
+            'period' => 'last_year',
+        );
+
+        // Generate the report.
+        return array(
+            'after'  => gmdate( 'Y-01-01' ),
+            'before' => gmdate( 'Y-12-31' ),
+        );
+
+    }
+
+    /**
+     * Retrieves last year date range.
+     *
+     * @return array The appropriate date range.
+     */
+    public function get_last_year_date_range() {
+
+        // Set the previous date range.
+        $this->previous_range = array(
+            'period' => 'custom',
+            'after'  => gmdate( 'Y-01-01', strtotime( '-2 years' ) ),
+            'before' => gmdate( 'Y-12-31', strtotime( '-2 years' ) ),
+        );
+
+        // Generate the report.
+        return array(
+            'after'  => gmdate( 'Y-01-01', strtotime( 'last year' ) ),
+            'before' => gmdate( 'Y-12-31', strtotime( 'last year' ) ),
+        );
+
+    }
+
+    /**
+     * Prepare a the request date for SQL usage.
+     *
+     * @param WP_REST_Request $request Request object.
+     * @param string $date_field The date field.
+     * @return string The appropriate SQL.
+     */
+    public function get_date_range_sql( $request, $date_field ) {
+        global $wpdb;
+
+        $sql = '1=1';
+        $range = $this->get_date_range( $request );
+
+        if ( ! empty( $range['after'] ) ) {
+            $sql .= ' AND ' . $wpdb->prepare(
+                "$date_field >= %s",
+                $range['after']
+            );
+        }
+
+        if ( ! empty( $range['before'] ) ) {
+            $sql .= ' AND ' . $wpdb->prepare(
+                "$date_field <= %s",
+                $range['before']
+            );
+        }
+
+        return $sql;
+
+    }
+
+    /**
+     * Prepares a group by query.
+     *
+     * @param string $date_field The date field.
+     * @return string The appropriate SQL.
+     */
+    public function get_group_by_sql( $date_field ) {
+
+        if ( 'day' === $this->groupby ) {
+            return "YEAR($date_field), MONTH($date_field), DAY($date_field)";
+        }
+
+        return "YEAR($date_field), MONTH($date_field)";
+    }
+
+    /**
+     * Get the query params for collections.
+     *
+     * @return array
+     */
+    public function get_collection_params() {
+        return array(
+            'context' => $this->get_context_param( array( 'default' => 'view' ) ),
+            'period'  => array(
+                'description'       => __( 'Limit to results of a specific period.', 'invoicing' ),
+                'type'              => 'string',
+                'enum'              => array( 'custom', 'today', 'yesterday', 'week', 'last_week', '7_days', '30_days', '60_days', '90_days', '180_days', 'month', 'last_month', 'quarter', 'last_quarter', 'year', 'last_year', 'quarter', 'last_quarter' ),
+                'validate_callback' => 'rest_validate_request_arg',
+                'sanitize_callback' => 'sanitize_text_field',
+                'default'           => '7_days',
+            ),
+            'after'   => array(
+                /* translators: %s: date format */
+                'description'       => sprintf( __( 'Limit to results after a specific date, the date needs to be in the %s format.', 'invoicing' ), 'YYYY-MM-DD' ),
+                'type'              => 'string',
+                'validate_callback' => 'rest_validate_request_arg',
+                'sanitize_callback' => 'sanitize_text_field',
+                'default'           => gmdate( 'Y-m-d', strtotime( '-7 days' ) ),
+            ),
+            'before'  => array(
+                /* translators: %s: date format */
+                'description'       => sprintf( __( 'Limit to results before a specific date, the date needs to be in the %s format.', 'invoicing' ), 'YYYY-MM-DD' ),
+                'type'              => 'string',
+                'validate_callback' => 'rest_validate_request_arg',
+                'sanitize_callback' => 'sanitize_text_field',
+                'default'           => gmdate( 'Y-m-d' ),
+            ),
+        );
+    }
 }

includes/api/class-getpaid-rest-report-sales-controller.php

Indentation +679 added lines, -679 removed lines

@@ -18,688 +18,688 @@
  */
 class GetPaid_REST_Report_Sales_Controller extends GetPaid_REST_Date_Based_Controller {
 
-	/**
-	 * Route base.
-	 *
-	 * @var string
-	 */
-	protected $rest_base = 'reports/sales';
-
-	/**
-	 * The report data.
-	 *
-	 * @var stdClass
-	 */
-	public $report_data;
-
-	/**
-	 * The report range.
-	 *
-	 * @var array
-	 */
-	public $report_range;
-
-	/**
-	 * Registers the routes for the objects of the controller.
-	 *
-	 * @since 2.0.0
-	 *
-	 * @see register_rest_route()
-	 */
-	public function register_namespace_routes( $namespace ) {
-
-		// Get sales report.
-		register_rest_route(
-			$namespace,
-			$this->rest_base,
-			array(
-				array(
-					'methods'             => WP_REST_Server::READABLE,
-					'callback'            => array( $this, 'get_items' ),
-					'permission_callback' => array( $this, 'get_items_permissions_check' ),
-					'args'                => $this->get_collection_params(),
-				),
-				'schema' => array( $this, 'get_public_item_schema' ),
-			)
-		);
-
-	}
-
-	/**
-	 * Makes sure the current user has access to READ the report APIs.
-	 *
-	 * @since  2.0.0
-	 * @param WP_REST_Request $request Full data about the request.
-	 * @return WP_Error|boolean
-	 */
-	public function get_items_permissions_check( $request ) {
-
-		if ( ! wpinv_current_user_can_manage_invoicing() ) {
-			return new WP_Error( 'rest_cannot_view', __( 'Sorry, you cannot list resources.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) );
-		}
-
-		return true;
-	}
-
-	/**
-	 * Get sales reports.
-	 *
-	 * @param WP_REST_Request $request
-	 * @return array|WP_Error
-	 */
-	public function get_items( $request ) {
-		$data   = array();
-		$item   = $this->prepare_item_for_response( null, $request );
-		$data[] = $this->prepare_response_for_collection( $item );
-
-		return rest_ensure_response( $data );
-	}
-
-	/**
-	 * Prepare a report sales object for serialization.
-	 *
-	 * @param null $_
-	 * @param WP_REST_Request $request Request object.
-	 * @return WP_REST_Response $response Response data.
-	 */
-	public function prepare_item_for_response( $_, $request ) {
-
-		// Set report range.
-		$this->report_range = $this->get_date_range( $request );
-
-		$report_data     = $this->get_report_data();
-		$period_totals   = array();
-
-		// Setup period totals by ensuring each period in the interval has data.
-		$start_date      = strtotime( $this->report_range['after'] );
-
-		if ( 'month' === $this->groupby ) {
-			$start_date      = strtotime( gmdate( 'Y-m-01', $start_date ) );
-		}
-
-		for ( $i = 0; $i < $this->interval; $i++ ) {
-
-			switch ( $this->groupby ) {
-				case 'day':
-					$time = gmdate( 'Y-m-d', strtotime( "+{$i} DAY", $start_date ) );
-					break;
-				default:
-					$time = gmdate( 'Y-m', strtotime( "+{$i} MONTH", $start_date ) );
-					break;
-			}
-
-			// Set the defaults for each period.
-			$period_totals[ $time ] = array(
-				'invoices'          => 0,
-				'items'             => 0,
-				'refunded_items'    => 0,
-				'refunded_tax'      => wpinv_round_amount( 0.00 ),
-				'subtotal'          => wpinv_round_amount( 0.00 ),
-				'refunded_subtotal' => wpinv_round_amount( 0.00 ),
-				'refunded_fees'     => wpinv_round_amount( 0.00 ),
-				'discount'          => wpinv_round_amount( 0.00 ),
-			);
-
-			foreach ( array_keys( wpinv_get_report_graphs() ) as $key ) {
-				if ( ! isset( $period_totals[ $time ][ $key ] ) ) {
-					$period_totals[ $time ][ $key ] = wpinv_round_amount( 0.00 );
-				}
-			}
-		}
-
-		// add total sales, total invoice count, total tax for each period
-		$date_format = ( 'day' === $this->groupby ) ? 'Y-m-d' : 'Y-m';
-		foreach ( $report_data->invoices as $invoice ) {
-			$time = gmdate( $date_format, strtotime( $invoice->post_date ) );
-
-			if ( ! isset( $period_totals[ $time ] ) ) {
-				continue;
-			}
-
-			$period_totals[ $time ]['sales']    = wpinv_round_amount( $invoice->total_sales );
-			$period_totals[ $time ]['tax']      = wpinv_round_amount( $invoice->total_tax );
-			$period_totals[ $time ]['subtotal'] = wpinv_round_amount( $invoice->subtotal );
-			$period_totals[ $time ]['fees']     = wpinv_round_amount( $invoice->total_fees );
-
-		}
-
-		foreach ( $report_data->refunds as $invoice ) {
-			$time = gmdate( $date_format, strtotime( $invoice->post_date ) );
-
-			if ( ! isset( $period_totals[ $time ] ) ) {
-				continue;
-			}
-
-			$period_totals[ $time ]['refunds']           = wpinv_round_amount( $invoice->total_sales );
-			$period_totals[ $time ]['refunded_tax']      = wpinv_round_amount( $invoice->total_tax );
-			$period_totals[ $time ]['refunded_subtotal'] = wpinv_round_amount( $invoice->subtotal );
-			$period_totals[ $time ]['refunded_fees']     = wpinv_round_amount( $invoice->total_fees );
-
-		}
-
-		foreach ( $report_data->invoice_counts as $invoice ) {
-			$time = gmdate( $date_format, strtotime( $invoice->post_date ) );
-
-			if ( isset( $period_totals[ $time ] ) ) {
-				$period_totals[ $time ]['invoices']   = (int) $invoice->count;
-			}
-		}
-
-		// Add total invoice items for each period.
-		foreach ( $report_data->invoice_items as $invoice_item ) {
-			$time = ( 'day' === $this->groupby ) ? gmdate( 'Y-m-d', strtotime( $invoice_item->post_date ) ) : gmdate( 'Y-m', strtotime( $invoice_item->post_date ) );
-
-			if ( isset( $period_totals[ $time ] ) ) {
-				$period_totals[ $time ]['items'] = (int) $invoice_item->invoice_item_count;
-			}
-		}
-
-		// Add total discount for each period.
-		foreach ( $report_data->coupons as $discount ) {
-			$time = ( 'day' === $this->groupby ) ? gmdate( 'Y-m-d', strtotime( $discount->post_date ) ) : gmdate( 'Y-m', strtotime( $discount->post_date ) );
-
-			if ( isset( $period_totals[ $time ] ) ) {
-				$period_totals[ $time ]['discount'] = wpinv_round_amount( $discount->discount_amount );
-			}
-		}
-
-		// Extra fields.
-		foreach ( array_keys( wpinv_get_report_graphs() ) as $key ) {
-
-			// Abort unprepared.
-			if ( ! isset( $report_data->$key ) ) {
-				continue;
-			} 
-
-			// Abort defaults.
-			if ( in_array( $key, array( 'sales', 'refunds', 'tax', 'fees', 'discount', 'invoices', 'items' ) ) ) {
-				continue;
-			}
-
-			// Set values.
-			foreach ( $report_data->$key as $item ) {
-				$time = ( 'day' === $this->groupby ) ? gmdate( 'Y-m-d', strtotime( $item->date ) ) : gmdate( 'Y-m', strtotime( $item->date ) );
-
-				if ( isset( $period_totals[ $time ] ) ) {
-					$period_totals[ $time ][ $key ] = wpinv_round_amount( $item->val );
-				}
-			}
-
-			unset( $report_data->$key );
-		}
-
-		$report_data->totals            = $period_totals;
-		$report_data->grouped_by        = $this->groupby;
-		$report_data->interval          = max( $this->interval, 1 );
-		$report_data->currency          = wpinv_get_currency();
-		$report_data->currency_symbol   = wpinv_currency_symbol();
-		$report_data->currency_position = wpinv_currency_position();
-		$report_data->decimal_places    = wpinv_decimals();
-		$report_data->thousands_sep     = wpinv_thousands_separator();
-		$report_data->decimals_sep      = wpinv_decimal_separator();
-		$report_data->start_date        = gmdate( 'Y-m-d', strtotime( $this->report_range['after'] ) );
-		$report_data->end_date          = gmdate( 'Y-m-d', strtotime( $this->report_range['before'] ) );
-		$report_data->start_date_locale = getpaid_format_date( gmdate( 'Y-m-d', strtotime( $this->report_range['after'] ) ) );
-		$report_data->end_date_locale   = getpaid_format_date( gmdate( 'Y-m-d', strtotime( $this->report_range['before'] ) ) );
-		$report_data->decimals_sep      = wpinv_decimal_separator();
-
-		$context = ! empty( $request['context'] ) ? $request['context'] : 'view';
-		$data    = $report_data;
-		unset( $data->invoice_counts, $data->invoices, $data->coupons, $data->refunds, $data->invoice_items );
-		$data    = $this->add_additional_fields_to_object( (array) $data, $request );
-		$data    = $this->filter_response_by_context( $data, $context );
-
-		// Wrap the data in a response object.
-		$response = rest_ensure_response( $data );
-		$response->add_links(
+    /**
+     * Route base.
+     *
+     * @var string
+     */
+    protected $rest_base = 'reports/sales';
+
+    /**
+     * The report data.
+     *
+     * @var stdClass
+     */
+    public $report_data;
+
+    /**
+     * The report range.
+     *
+     * @var array
+     */
+    public $report_range;
+
+    /**
+     * Registers the routes for the objects of the controller.
+     *
+     * @since 2.0.0
+     *
+     * @see register_rest_route()
+     */
+    public function register_namespace_routes( $namespace ) {
+
+        // Get sales report.
+        register_rest_route(
+            $namespace,
+            $this->rest_base,
             array(
-				'about' => array(
-					'href' => rest_url( sprintf( '%s/reports', $this->namespace ) ),
-				),
+                array(
+                    'methods'             => WP_REST_Server::READABLE,
+                    'callback'            => array( $this, 'get_items' ),
+                    'permission_callback' => array( $this, 'get_items_permissions_check' ),
+                    'args'                => $this->get_collection_params(),
+                ),
+                'schema' => array( $this, 'get_public_item_schema' ),
             )
         );
 
-		return apply_filters( 'getpaid_rest_prepare_report_sales', $response, $report_data, $request );
-	}
-
-	/**
-	 * Get report data.
-	 *
-	 * @return stdClass
-	 */
-	public function get_report_data() {
-		if ( empty( $this->report_data ) ) {
-			$this->query_report_data();
-		}
-		return $this->report_data;
-	}
-
-	/**
-	 * Get all data needed for this report and store in the class.
-	 */
-	protected function query_report_data() {
-
-		// Prepare reports.
-		$this->report_data = (object) array(
-			'invoice_counts' => $this->query_invoice_counts(), //count, post_date
-			'coupons'        => $this->query_coupon_counts(), // discount_amount, post_date
-			'invoice_items'  => $this->query_item_counts(), // invoice_item_count, post_date
-			'refunded_items' => $this->count_refunded_items(), // invoice_item_count, post_date
-			'invoices'       => $this->query_invoice_totals(), // total_sales, total_tax, total_discount, total_fees, subtotal, post_date
-			'refunds'        => $this->query_refunded_totals(), // total_sales, total_tax, total_discount, total_fees, subtotal, post_date
-			'previous_range' => $this->previous_range,
-		);
-
-		// Calculated totals.
-		$this->report_data->total_tax          = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_tax' ) ) );
-		$this->report_data->total_sales        = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_sales' ) ) );
-		$this->report_data->total_discount     = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_discount' ) ) );
-		$this->report_data->total_fees         = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_fees' ) ) );
-		$this->report_data->subtotal           = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'subtotal' ) ) );
-		$this->report_data->net_sales          = wpinv_round_amount( $this->report_data->total_sales - max( 0, $this->report_data->total_tax ) );
-		$this->report_data->total_refunded_tax = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_tax' ) ) );
-		$this->report_data->total_refunds      = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_sales' ) ) );
-		$this->report_data->refunded_discount  = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_discount' ) ) );
-		$this->report_data->refunded_fees      = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_fees' ) ) );
-		$this->report_data->refunded_subtotal  = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'subtotal' ) ) );
-		$this->report_data->net_refunds        = wpinv_round_amount( $this->report_data->total_refunds + max( 0, $this->report_data->total_refunded_tax ) );
-
-		// Calculate average based on net.
-		$this->report_data->average_sales       = wpinv_round_amount( $this->report_data->net_sales / max( $this->interval, 1 ), 2 );
-		$this->report_data->average_total_sales = wpinv_round_amount( $this->report_data->total_sales / max( $this->interval, 1 ), 2 );
-
-		// Total invoices in this period, even if refunded.
-		$this->report_data->total_invoices = absint( array_sum( wp_list_pluck( $this->report_data->invoice_counts, 'count' ) ) );
-
-		// Items invoiced in this period, even if refunded.
-		$this->report_data->total_items = absint( array_sum( wp_list_pluck( $this->report_data->invoice_items, 'invoice_item_count' ) ) );
-
-		// 3rd party filtering of report data
-		$this->report_data = apply_filters( 'getpaid_rest_api_filter_report_data', $this->report_data, $this );
-	}
-
-	/**
-	 * Prepares invoice counts.
-	 *
-	 * @return array.
-	 */
-	protected function query_invoice_counts() {
-
-		return (array) GetPaid_Reports_Helper::get_invoice_report_data(
-			array(
-				'data'           => array(
-					'ID'        => array(
-						'type'     => 'post_data',
-						'function' => 'COUNT',
-						'name'     => 'count',
-						'distinct' => true,
-					),
-					'post_date' => array(
-						'type'     => 'post_data',
-						'function' => 'MIN',
-						'name'     => 'post_date',
-					),
-				),
-				'group_by'       => $this->get_group_by_sql( 'posts.post_date' ),
-				'order_by'       => 'post_date ASC',
-				'query_type'     => 'get_results',
-				'filter_range'   => $this->report_range,
-				'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-refunded', 'wpi-renewal' ),
-			)
-		);
-
-	}
-
-	/**
-	 * Prepares coupon counts.
-	 *
-	 * @return array.
-	 */
-	protected function query_coupon_counts() {
-
-		return (array) GetPaid_Reports_Helper::get_invoice_report_data(
-			array(
-				'data'           => array(
-					'discount'  => array(
-						'type'     => 'invoice_data',
-						'function' => 'SUM',
-						'name'     => 'discount_amount',
-					),
-					'post_date' => array(
-						'type'     => 'post_data',
-						'function' => 'MIN',
-						'name'     => 'post_date',
-					),
-				),
-				'group_by'       => $this->get_group_by_sql( 'posts.post_date' ),
-				'order_by'       => 'post_date ASC',
-				'query_type'     => 'get_results',
-				'filter_range'   => $this->report_range,
-				'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-refunded', 'wpi-renewal' ),
-			)
-		);
-
-	}
-
-	/**
-	 * Prepares item counts.
-	 *
-	 * @return array.
-	 */
-	protected function query_item_counts() {
-
-		return (array) GetPaid_Reports_Helper::get_invoice_report_data(
-			array(
-				'data'           => array(
-					'quantity'  => array(
-						'type'     => 'invoice_item',
-						'function' => 'SUM',
-						'name'     => 'invoice_item_count',
-					),
-					'post_date' => array(
-						'type'     => 'post_data',
-						'function' => 'MIN',
-						'name'     => 'post_date',
-					),
-				),
-				'group_by'       => $this->get_group_by_sql( 'posts.post_date' ),
-				'order_by'       => 'post_date ASC',
-				'query_type'     => 'get_results',
-				'filter_range'   => $this->report_range,
-				'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-refunded', 'wpi-renewal' ),
-			)
-		);
-
-	}
-
-	/**
-	 * Prepares refunded item counts.
-	 *
-	 * @return array.
-	 */
-	protected function count_refunded_items() {
-
-		return (int) GetPaid_Reports_Helper::get_invoice_report_data(
-			array(
-				'data'           => array(
-					'quantity' => array(
-						'type'     => 'invoice_item',
-						'function' => 'SUM',
-						'name'     => 'invoice_item_count',
-					),
-				),
-				'query_type'     => 'get_var',
-				'filter_range'   => $this->report_range,
-				'invoice_status' => array( 'wpi-refunded' ),
-			)
-		);
-
-	}
-
-	/**
-	 * Prepares daily invoice totals.
-	 *
-	 * @return array.
-	 */
-	protected function query_invoice_totals() {
-
-		return (array) GetPaid_Reports_Helper::get_invoice_report_data(
-			array(
-				'data'           => array(
-					'total'      => array(
-						'type'     => 'invoice_data',
-						'function' => 'SUM',
-						'name'     => 'total_sales',
-					),
-					'tax'        => array(
-						'type'     => 'invoice_data',
-						'function' => 'SUM',
-						'name'     => 'total_tax',
-					),
-					'discount'   => array(
-						'type'     => 'invoice_data',
-						'function' => 'SUM',
-						'name'     => 'total_discount',
-					),
-					'fees_total' => array(
-						'type'     => 'invoice_data',
-						'function' => 'SUM',
-						'name'     => 'total_fees',
-					),
-					'subtotal'   => array(
-						'type'     => 'invoice_data',
-						'function' => 'SUM',
-						'name'     => 'subtotal',
-					),
-					'post_date'  => array(
-						'type'     => 'post_data',
-						'function' => '',
-						'name'     => 'post_date',
-					),
-				),
-				'group_by'       => $this->get_group_by_sql( 'posts.post_date' ),
-				'order_by'       => 'post_date ASC',
-				'query_type'     => 'get_results',
-				'filter_range'   => $this->report_range,
-				'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-renewal' ),
-			)
-		);
-
-	}
-
-	/**
-	 * Prepares daily invoice totals.
-	 *
-	 * @return array.
-	 */
-	protected function query_refunded_totals() {
-
-		return (array) GetPaid_Reports_Helper::get_invoice_report_data(
-			array(
-				'data'           => array(
-					'total'      => array(
-						'type'     => 'invoice_data',
-						'function' => 'SUM',
-						'name'     => 'total_sales',
-					),
-					'tax'        => array(
-						'type'     => 'invoice_data',
-						'function' => 'SUM',
-						'name'     => 'total_tax',
-					),
-					'discount'   => array(
-						'type'     => 'invoice_data',
-						'function' => 'SUM',
-						'name'     => 'total_discount',
-					),
-					'fees_total' => array(
-						'type'     => 'invoice_data',
-						'function' => 'SUM',
-						'name'     => 'total_fees',
-					),
-					'subtotal'   => array(
-						'type'     => 'invoice_data',
-						'function' => 'SUM',
-						'name'     => 'subtotal',
-					),
-					'post_date'  => array(
-						'type'     => 'post_data',
-						'function' => '',
-						'name'     => 'post_date',
-					),
-				),
-				'group_by'       => $this->get_group_by_sql( 'posts.post_date' ),
-				'order_by'       => 'post_date ASC',
-				'query_type'     => 'get_results',
-				'filter_range'   => $this->report_range,
-				'invoice_status' => array( 'wpi-refunded' ),
-			)
-		);
-
-	}
-
-	/**
-	 * Get the Report's schema, conforming to JSON Schema.
-	 *
-	 * @return array
-	 */
-	public function get_item_schema() {
-
-		$schema = array(
-			'$schema'    => 'http://json-schema.org/draft-04/schema#',
-			'title'      => 'sales_report',
-			'type'       => 'object',
-			'properties' => array(
-				'total_sales'         => array(
-					'description' => __( 'Gross sales in the period.', 'invoicing' ),
-					'type'        => 'string',
-					'context'     => array( 'view' ),
-					'readonly'    => true,
-				),
-				'net_sales'           => array(
-					'description' => __( 'Net sales in the period.', 'invoicing' ),
-					'type'        => 'string',
-					'context'     => array( 'view' ),
-					'readonly'    => true,
-				),
-				'average_sales'       => array(
-					'description' => __( 'Average net daily sales.', 'invoicing' ),
-					'type'        => 'string',
-					'context'     => array( 'view' ),
-					'readonly'    => true,
-				),
-				'average_total_sales' => array(
-					'description' => __( 'Average gross daily sales.', 'invoicing' ),
-					'type'        => 'string',
-					'context'     => array( 'view' ),
-					'readonly'    => true,
-				),
-				'total_invoices'      => array(
-					'description' => __( 'Number of paid invoices.', 'invoicing' ),
-					'type'        => 'integer',
-					'context'     => array( 'view' ),
-					'readonly'    => true,
-				),
-				'total_items'         => array(
-					'description' => __( 'Number of items purchased.', 'invoicing' ),
-					'type'        => 'integer',
-					'context'     => array( 'view' ),
-					'readonly'    => true,
-				),
-				'refunded_items'      => array(
-					'description' => __( 'Number of items refunded.', 'invoicing' ),
-					'type'        => 'integer',
-					'context'     => array( 'view' ),
-					'readonly'    => true,
-				),
-				'total_tax'           => array(
-					'description' => __( 'Total charged for taxes.', 'invoicing' ),
-					'type'        => 'string',
-					'context'     => array( 'view' ),
-					'readonly'    => true,
-				),
-				'total_refunded_tax'  => array(
-					'description' => __( 'Total refunded for taxes.', 'invoicing' ),
-					'type'        => 'string',
-					'context'     => array( 'view' ),
-					'readonly'    => true,
-				),
-				'total_fees'          => array(
-					'description' => __( 'Total fees charged.', 'invoicing' ),
-					'type'        => 'string',
-					'context'     => array( 'view' ),
-					'readonly'    => true,
-				),
-				'total_refunds'       => array(
-					'description' => __( 'Total of refunded invoices.', 'invoicing' ),
-					'type'        => 'integer',
-					'context'     => array( 'view' ),
-					'readonly'    => true,
-				),
-				'net_refunds'         => array(
-					'description' => __( 'Net of refunded invoices.', 'invoicing' ),
-					'type'        => 'integer',
-					'context'     => array( 'view' ),
-					'readonly'    => true,
-				),
-				'total_discount'      => array(
-					'description' => __( 'Total of discounts used.', 'invoicing' ),
-					'type'        => 'integer',
-					'context'     => array( 'view' ),
-					'readonly'    => true,
-				),
-				'totals'              => array(
-					'description' => __( 'Totals.', 'invoicing' ),
-					'type'        => 'array',
-					'items'       => array(
-						'type' => 'array',
-					),
-					'context'     => array( 'view' ),
-					'readonly'    => true,
-				),
-				'interval'            => array(
-					'description' => __( 'Number of months/days in the report period.', 'invoicing' ),
-					'type'        => 'integer',
-					'context'     => array( 'view' ),
-					'readonly'    => true,
-				),
-				'previous_range'      => array(
-					'description' => __( 'The previous report period.', 'invoicing' ),
-					'type'        => 'array',
-					'items'       => array(
-						'type' => 'string',
-					),
-					'context'     => array( 'view' ),
-					'readonly'    => true,
-				),
-				'grouped_by'          => array(
-					'description' => __( 'The period used to group the totals.', 'invoicing' ),
-					'type'        => 'string',
-					'context'     => array( 'view' ),
-					'enum'        => array( 'day', 'month' ),
-					'readonly'    => true,
-				),
-				'currency'            => array(
-					'description' => __( 'The default store currency.', 'invoicing' ),
-					'type'        => 'string',
-					'context'     => array( 'view' ),
-					'readonly'    => true,
-				),
-				'currency_symbol'     => array(
-					'description' => __( 'The default store currency symbol.', 'invoicing' ),
-					'type'        => 'string',
-					'context'     => array( 'view' ),
-					'readonly'    => true,
-				),
-				'currency_position'   => array(
-					'description' => __( 'The default store currency position.', 'invoicing' ),
-					'type'        => 'string',
-					'context'     => array( 'view' ),
-					'readonly'    => true,
-				),
-				'decimal_places'      => array(
-					'description' => __( 'The default store decimal places.', 'invoicing' ),
-					'type'        => 'string',
-					'context'     => array( 'view' ),
-					'readonly'    => true,
-				),
-				'thousands_sep'       => array(
-					'description' => __( 'The default store thousands separator.', 'invoicing' ),
-					'type'        => 'string',
-					'context'     => array( 'view' ),
-					'readonly'    => true,
-				),
-				'decimals_sep'        => array(
-					'description' => __( 'The default store decimals separator.', 'invoicing' ),
-					'type'        => 'string',
-					'context'     => array( 'view' ),
-					'readonly'    => true,
-				),
-			),
-		);
-
-		return $this->add_additional_fields_schema( $schema );
-
-	}
+    }
+
+    /**
+     * Makes sure the current user has access to READ the report APIs.
+     *
+     * @since  2.0.0
+     * @param WP_REST_Request $request Full data about the request.
+     * @return WP_Error|boolean
+     */
+    public function get_items_permissions_check( $request ) {
+
+        if ( ! wpinv_current_user_can_manage_invoicing() ) {
+            return new WP_Error( 'rest_cannot_view', __( 'Sorry, you cannot list resources.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) );
+        }
+
+        return true;
+    }
+
+    /**
+     * Get sales reports.
+     *
+     * @param WP_REST_Request $request
+     * @return array|WP_Error
+     */
+    public function get_items( $request ) {
+        $data   = array();
+        $item   = $this->prepare_item_for_response( null, $request );
+        $data[] = $this->prepare_response_for_collection( $item );
+
+        return rest_ensure_response( $data );
+    }
+
+    /**
+     * Prepare a report sales object for serialization.
+     *
+     * @param null $_
+     * @param WP_REST_Request $request Request object.
+     * @return WP_REST_Response $response Response data.
+     */
+    public function prepare_item_for_response( $_, $request ) {
+
+        // Set report range.
+        $this->report_range = $this->get_date_range( $request );
+
+        $report_data     = $this->get_report_data();
+        $period_totals   = array();
+
+        // Setup period totals by ensuring each period in the interval has data.
+        $start_date      = strtotime( $this->report_range['after'] );
+
+        if ( 'month' === $this->groupby ) {
+            $start_date      = strtotime( gmdate( 'Y-m-01', $start_date ) );
+        }
+
+        for ( $i = 0; $i < $this->interval; $i++ ) {
+
+            switch ( $this->groupby ) {
+                case 'day':
+                    $time = gmdate( 'Y-m-d', strtotime( "+{$i} DAY", $start_date ) );
+                    break;
+                default:
+                    $time = gmdate( 'Y-m', strtotime( "+{$i} MONTH", $start_date ) );
+                    break;
+            }
+
+            // Set the defaults for each period.
+            $period_totals[ $time ] = array(
+                'invoices'          => 0,
+                'items'             => 0,
+                'refunded_items'    => 0,
+                'refunded_tax'      => wpinv_round_amount( 0.00 ),
+                'subtotal'          => wpinv_round_amount( 0.00 ),
+                'refunded_subtotal' => wpinv_round_amount( 0.00 ),
+                'refunded_fees'     => wpinv_round_amount( 0.00 ),
+                'discount'          => wpinv_round_amount( 0.00 ),
+            );
+
+            foreach ( array_keys( wpinv_get_report_graphs() ) as $key ) {
+                if ( ! isset( $period_totals[ $time ][ $key ] ) ) {
+                    $period_totals[ $time ][ $key ] = wpinv_round_amount( 0.00 );
+                }
+            }
+        }
+
+        // add total sales, total invoice count, total tax for each period
+        $date_format = ( 'day' === $this->groupby ) ? 'Y-m-d' : 'Y-m';
+        foreach ( $report_data->invoices as $invoice ) {
+            $time = gmdate( $date_format, strtotime( $invoice->post_date ) );
+
+            if ( ! isset( $period_totals[ $time ] ) ) {
+                continue;
+            }
+
+            $period_totals[ $time ]['sales']    = wpinv_round_amount( $invoice->total_sales );
+            $period_totals[ $time ]['tax']      = wpinv_round_amount( $invoice->total_tax );
+            $period_totals[ $time ]['subtotal'] = wpinv_round_amount( $invoice->subtotal );
+            $period_totals[ $time ]['fees']     = wpinv_round_amount( $invoice->total_fees );
+
+        }
+
+        foreach ( $report_data->refunds as $invoice ) {
+            $time = gmdate( $date_format, strtotime( $invoice->post_date ) );
+
+            if ( ! isset( $period_totals[ $time ] ) ) {
+                continue;
+            }
+
+            $period_totals[ $time ]['refunds']           = wpinv_round_amount( $invoice->total_sales );
+            $period_totals[ $time ]['refunded_tax']      = wpinv_round_amount( $invoice->total_tax );
+            $period_totals[ $time ]['refunded_subtotal'] = wpinv_round_amount( $invoice->subtotal );
+            $period_totals[ $time ]['refunded_fees']     = wpinv_round_amount( $invoice->total_fees );
+
+        }
+
+        foreach ( $report_data->invoice_counts as $invoice ) {
+            $time = gmdate( $date_format, strtotime( $invoice->post_date ) );
+
+            if ( isset( $period_totals[ $time ] ) ) {
+                $period_totals[ $time ]['invoices']   = (int) $invoice->count;
+            }
+        }
+
+        // Add total invoice items for each period.
+        foreach ( $report_data->invoice_items as $invoice_item ) {
+            $time = ( 'day' === $this->groupby ) ? gmdate( 'Y-m-d', strtotime( $invoice_item->post_date ) ) : gmdate( 'Y-m', strtotime( $invoice_item->post_date ) );
+
+            if ( isset( $period_totals[ $time ] ) ) {
+                $period_totals[ $time ]['items'] = (int) $invoice_item->invoice_item_count;
+            }
+        }
+
+        // Add total discount for each period.
+        foreach ( $report_data->coupons as $discount ) {
+            $time = ( 'day' === $this->groupby ) ? gmdate( 'Y-m-d', strtotime( $discount->post_date ) ) : gmdate( 'Y-m', strtotime( $discount->post_date ) );
+
+            if ( isset( $period_totals[ $time ] ) ) {
+                $period_totals[ $time ]['discount'] = wpinv_round_amount( $discount->discount_amount );
+            }
+        }
+
+        // Extra fields.
+        foreach ( array_keys( wpinv_get_report_graphs() ) as $key ) {
+
+            // Abort unprepared.
+            if ( ! isset( $report_data->$key ) ) {
+                continue;
+            } 
+
+            // Abort defaults.
+            if ( in_array( $key, array( 'sales', 'refunds', 'tax', 'fees', 'discount', 'invoices', 'items' ) ) ) {
+                continue;
+            }
+
+            // Set values.
+            foreach ( $report_data->$key as $item ) {
+                $time = ( 'day' === $this->groupby ) ? gmdate( 'Y-m-d', strtotime( $item->date ) ) : gmdate( 'Y-m', strtotime( $item->date ) );
+
+                if ( isset( $period_totals[ $time ] ) ) {
+                    $period_totals[ $time ][ $key ] = wpinv_round_amount( $item->val );
+                }
+            }
+
+            unset( $report_data->$key );
+        }
+
+        $report_data->totals            = $period_totals;
+        $report_data->grouped_by        = $this->groupby;
+        $report_data->interval          = max( $this->interval, 1 );
+        $report_data->currency          = wpinv_get_currency();
+        $report_data->currency_symbol   = wpinv_currency_symbol();
+        $report_data->currency_position = wpinv_currency_position();
+        $report_data->decimal_places    = wpinv_decimals();
+        $report_data->thousands_sep     = wpinv_thousands_separator();
+        $report_data->decimals_sep      = wpinv_decimal_separator();
+        $report_data->start_date        = gmdate( 'Y-m-d', strtotime( $this->report_range['after'] ) );
+        $report_data->end_date          = gmdate( 'Y-m-d', strtotime( $this->report_range['before'] ) );
+        $report_data->start_date_locale = getpaid_format_date( gmdate( 'Y-m-d', strtotime( $this->report_range['after'] ) ) );
+        $report_data->end_date_locale   = getpaid_format_date( gmdate( 'Y-m-d', strtotime( $this->report_range['before'] ) ) );
+        $report_data->decimals_sep      = wpinv_decimal_separator();
+
+        $context = ! empty( $request['context'] ) ? $request['context'] : 'view';
+        $data    = $report_data;
+        unset( $data->invoice_counts, $data->invoices, $data->coupons, $data->refunds, $data->invoice_items );
+        $data    = $this->add_additional_fields_to_object( (array) $data, $request );
+        $data    = $this->filter_response_by_context( $data, $context );
+
+        // Wrap the data in a response object.
+        $response = rest_ensure_response( $data );
+        $response->add_links(
+            array(
+                'about' => array(
+                    'href' => rest_url( sprintf( '%s/reports', $this->namespace ) ),
+                ),
+            )
+        );
+
+        return apply_filters( 'getpaid_rest_prepare_report_sales', $response, $report_data, $request );
+    }
+
+    /**
+     * Get report data.
+     *
+     * @return stdClass
+     */
+    public function get_report_data() {
+        if ( empty( $this->report_data ) ) {
+            $this->query_report_data();
+        }
+        return $this->report_data;
+    }
+
+    /**
+     * Get all data needed for this report and store in the class.
+     */
+    protected function query_report_data() {
+
+        // Prepare reports.
+        $this->report_data = (object) array(
+            'invoice_counts' => $this->query_invoice_counts(), //count, post_date
+            'coupons'        => $this->query_coupon_counts(), // discount_amount, post_date
+            'invoice_items'  => $this->query_item_counts(), // invoice_item_count, post_date
+            'refunded_items' => $this->count_refunded_items(), // invoice_item_count, post_date
+            'invoices'       => $this->query_invoice_totals(), // total_sales, total_tax, total_discount, total_fees, subtotal, post_date
+            'refunds'        => $this->query_refunded_totals(), // total_sales, total_tax, total_discount, total_fees, subtotal, post_date
+            'previous_range' => $this->previous_range,
+        );
+
+        // Calculated totals.
+        $this->report_data->total_tax          = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_tax' ) ) );
+        $this->report_data->total_sales        = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_sales' ) ) );
+        $this->report_data->total_discount     = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_discount' ) ) );
+        $this->report_data->total_fees         = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_fees' ) ) );
+        $this->report_data->subtotal           = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'subtotal' ) ) );
+        $this->report_data->net_sales          = wpinv_round_amount( $this->report_data->total_sales - max( 0, $this->report_data->total_tax ) );
+        $this->report_data->total_refunded_tax = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_tax' ) ) );
+        $this->report_data->total_refunds      = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_sales' ) ) );
+        $this->report_data->refunded_discount  = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_discount' ) ) );
+        $this->report_data->refunded_fees      = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_fees' ) ) );
+        $this->report_data->refunded_subtotal  = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'subtotal' ) ) );
+        $this->report_data->net_refunds        = wpinv_round_amount( $this->report_data->total_refunds + max( 0, $this->report_data->total_refunded_tax ) );
+
+        // Calculate average based on net.
+        $this->report_data->average_sales       = wpinv_round_amount( $this->report_data->net_sales / max( $this->interval, 1 ), 2 );
+        $this->report_data->average_total_sales = wpinv_round_amount( $this->report_data->total_sales / max( $this->interval, 1 ), 2 );
+
+        // Total invoices in this period, even if refunded.
+        $this->report_data->total_invoices = absint( array_sum( wp_list_pluck( $this->report_data->invoice_counts, 'count' ) ) );
+
+        // Items invoiced in this period, even if refunded.
+        $this->report_data->total_items = absint( array_sum( wp_list_pluck( $this->report_data->invoice_items, 'invoice_item_count' ) ) );
+
+        // 3rd party filtering of report data
+        $this->report_data = apply_filters( 'getpaid_rest_api_filter_report_data', $this->report_data, $this );
+    }
+
+    /**
+     * Prepares invoice counts.
+     *
+     * @return array.
+     */
+    protected function query_invoice_counts() {
+
+        return (array) GetPaid_Reports_Helper::get_invoice_report_data(
+            array(
+                'data'           => array(
+                    'ID'        => array(
+                        'type'     => 'post_data',
+                        'function' => 'COUNT',
+                        'name'     => 'count',
+                        'distinct' => true,
+                    ),
+                    'post_date' => array(
+                        'type'     => 'post_data',
+                        'function' => 'MIN',
+                        'name'     => 'post_date',
+                    ),
+                ),
+                'group_by'       => $this->get_group_by_sql( 'posts.post_date' ),
+                'order_by'       => 'post_date ASC',
+                'query_type'     => 'get_results',
+                'filter_range'   => $this->report_range,
+                'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-refunded', 'wpi-renewal' ),
+            )
+        );
+
+    }
+
+    /**
+     * Prepares coupon counts.
+     *
+     * @return array.
+     */
+    protected function query_coupon_counts() {
+
+        return (array) GetPaid_Reports_Helper::get_invoice_report_data(
+            array(
+                'data'           => array(
+                    'discount'  => array(
+                        'type'     => 'invoice_data',
+                        'function' => 'SUM',
+                        'name'     => 'discount_amount',
+                    ),
+                    'post_date' => array(
+                        'type'     => 'post_data',
+                        'function' => 'MIN',
+                        'name'     => 'post_date',
+                    ),
+                ),
+                'group_by'       => $this->get_group_by_sql( 'posts.post_date' ),
+                'order_by'       => 'post_date ASC',
+                'query_type'     => 'get_results',
+                'filter_range'   => $this->report_range,
+                'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-refunded', 'wpi-renewal' ),
+            )
+        );
+
+    }
+
+    /**
+     * Prepares item counts.
+     *
+     * @return array.
+     */
+    protected function query_item_counts() {
+
+        return (array) GetPaid_Reports_Helper::get_invoice_report_data(
+            array(
+                'data'           => array(
+                    'quantity'  => array(
+                        'type'     => 'invoice_item',
+                        'function' => 'SUM',
+                        'name'     => 'invoice_item_count',
+                    ),
+                    'post_date' => array(
+                        'type'     => 'post_data',
+                        'function' => 'MIN',
+                        'name'     => 'post_date',
+                    ),
+                ),
+                'group_by'       => $this->get_group_by_sql( 'posts.post_date' ),
+                'order_by'       => 'post_date ASC',
+                'query_type'     => 'get_results',
+                'filter_range'   => $this->report_range,
+                'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-refunded', 'wpi-renewal' ),
+            )
+        );
+
+    }
+
+    /**
+     * Prepares refunded item counts.
+     *
+     * @return array.
+     */
+    protected function count_refunded_items() {
+
+        return (int) GetPaid_Reports_Helper::get_invoice_report_data(
+            array(
+                'data'           => array(
+                    'quantity' => array(
+                        'type'     => 'invoice_item',
+                        'function' => 'SUM',
+                        'name'     => 'invoice_item_count',
+                    ),
+                ),
+                'query_type'     => 'get_var',
+                'filter_range'   => $this->report_range,
+                'invoice_status' => array( 'wpi-refunded' ),
+            )
+        );
+
+    }
+
+    /**
+     * Prepares daily invoice totals.
+     *
+     * @return array.
+     */
+    protected function query_invoice_totals() {
+
+        return (array) GetPaid_Reports_Helper::get_invoice_report_data(
+            array(
+                'data'           => array(
+                    'total'      => array(
+                        'type'     => 'invoice_data',
+                        'function' => 'SUM',
+                        'name'     => 'total_sales',
+                    ),
+                    'tax'        => array(
+                        'type'     => 'invoice_data',
+                        'function' => 'SUM',
+                        'name'     => 'total_tax',
+                    ),
+                    'discount'   => array(
+                        'type'     => 'invoice_data',
+                        'function' => 'SUM',
+                        'name'     => 'total_discount',
+                    ),
+                    'fees_total' => array(
+                        'type'     => 'invoice_data',
+                        'function' => 'SUM',
+                        'name'     => 'total_fees',
+                    ),
+                    'subtotal'   => array(
+                        'type'     => 'invoice_data',
+                        'function' => 'SUM',
+                        'name'     => 'subtotal',
+                    ),
+                    'post_date'  => array(
+                        'type'     => 'post_data',
+                        'function' => '',
+                        'name'     => 'post_date',
+                    ),
+                ),
+                'group_by'       => $this->get_group_by_sql( 'posts.post_date' ),
+                'order_by'       => 'post_date ASC',
+                'query_type'     => 'get_results',
+                'filter_range'   => $this->report_range,
+                'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-renewal' ),
+            )
+        );
+
+    }
+
+    /**
+     * Prepares daily invoice totals.
+     *
+     * @return array.
+     */
+    protected function query_refunded_totals() {
+
+        return (array) GetPaid_Reports_Helper::get_invoice_report_data(
+            array(
+                'data'           => array(
+                    'total'      => array(
+                        'type'     => 'invoice_data',
+                        'function' => 'SUM',
+                        'name'     => 'total_sales',
+                    ),
+                    'tax'        => array(
+                        'type'     => 'invoice_data',
+                        'function' => 'SUM',
+                        'name'     => 'total_tax',
+                    ),
+                    'discount'   => array(
+                        'type'     => 'invoice_data',
+                        'function' => 'SUM',
+                        'name'     => 'total_discount',
+                    ),
+                    'fees_total' => array(
+                        'type'     => 'invoice_data',
+                        'function' => 'SUM',
+                        'name'     => 'total_fees',
+                    ),
+                    'subtotal'   => array(
+                        'type'     => 'invoice_data',
+                        'function' => 'SUM',
+                        'name'     => 'subtotal',
+                    ),
+                    'post_date'  => array(
+                        'type'     => 'post_data',
+                        'function' => '',
+                        'name'     => 'post_date',
+                    ),
+                ),
+                'group_by'       => $this->get_group_by_sql( 'posts.post_date' ),
+                'order_by'       => 'post_date ASC',
+                'query_type'     => 'get_results',
+                'filter_range'   => $this->report_range,
+                'invoice_status' => array( 'wpi-refunded' ),
+            )
+        );
+
+    }
+
+    /**
+     * Get the Report's schema, conforming to JSON Schema.
+     *
+     * @return array
+     */
+    public function get_item_schema() {
+
+        $schema = array(
+            '$schema'    => 'http://json-schema.org/draft-04/schema#',
+            'title'      => 'sales_report',
+            'type'       => 'object',
+            'properties' => array(
+                'total_sales'         => array(
+                    'description' => __( 'Gross sales in the period.', 'invoicing' ),
+                    'type'        => 'string',
+                    'context'     => array( 'view' ),
+                    'readonly'    => true,
+                ),
+                'net_sales'           => array(
+                    'description' => __( 'Net sales in the period.', 'invoicing' ),
+                    'type'        => 'string',
+                    'context'     => array( 'view' ),
+                    'readonly'    => true,
+                ),
+                'average_sales'       => array(
+                    'description' => __( 'Average net daily sales.', 'invoicing' ),
+                    'type'        => 'string',
+                    'context'     => array( 'view' ),
+                    'readonly'    => true,
+                ),
+                'average_total_sales' => array(
+                    'description' => __( 'Average gross daily sales.', 'invoicing' ),
+                    'type'        => 'string',
+                    'context'     => array( 'view' ),
+                    'readonly'    => true,
+                ),
+                'total_invoices'      => array(
+                    'description' => __( 'Number of paid invoices.', 'invoicing' ),
+                    'type'        => 'integer',
+                    'context'     => array( 'view' ),
+                    'readonly'    => true,
+                ),
+                'total_items'         => array(
+                    'description' => __( 'Number of items purchased.', 'invoicing' ),
+                    'type'        => 'integer',
+                    'context'     => array( 'view' ),
+                    'readonly'    => true,
+                ),
+                'refunded_items'      => array(
+                    'description' => __( 'Number of items refunded.', 'invoicing' ),
+                    'type'        => 'integer',
+                    'context'     => array( 'view' ),
+                    'readonly'    => true,
+                ),
+                'total_tax'           => array(
+                    'description' => __( 'Total charged for taxes.', 'invoicing' ),
+                    'type'        => 'string',
+                    'context'     => array( 'view' ),
+                    'readonly'    => true,
+                ),
+                'total_refunded_tax'  => array(
+                    'description' => __( 'Total refunded for taxes.', 'invoicing' ),
+                    'type'        => 'string',
+                    'context'     => array( 'view' ),
+                    'readonly'    => true,
+                ),
+                'total_fees'          => array(
+                    'description' => __( 'Total fees charged.', 'invoicing' ),
+                    'type'        => 'string',
+                    'context'     => array( 'view' ),
+                    'readonly'    => true,
+                ),
+                'total_refunds'       => array(
+                    'description' => __( 'Total of refunded invoices.', 'invoicing' ),
+                    'type'        => 'integer',
+                    'context'     => array( 'view' ),
+                    'readonly'    => true,
+                ),
+                'net_refunds'         => array(
+                    'description' => __( 'Net of refunded invoices.', 'invoicing' ),
+                    'type'        => 'integer',
+                    'context'     => array( 'view' ),
+                    'readonly'    => true,
+                ),
+                'total_discount'      => array(
+                    'description' => __( 'Total of discounts used.', 'invoicing' ),
+                    'type'        => 'integer',
+                    'context'     => array( 'view' ),
+                    'readonly'    => true,
+                ),
+                'totals'              => array(
+                    'description' => __( 'Totals.', 'invoicing' ),
+                    'type'        => 'array',
+                    'items'       => array(
+                        'type' => 'array',
+                    ),
+                    'context'     => array( 'view' ),
+                    'readonly'    => true,
+                ),
+                'interval'            => array(
+                    'description' => __( 'Number of months/days in the report period.', 'invoicing' ),
+                    'type'        => 'integer',
+                    'context'     => array( 'view' ),
+                    'readonly'    => true,
+                ),
+                'previous_range'      => array(
+                    'description' => __( 'The previous report period.', 'invoicing' ),
+                    'type'        => 'array',
+                    'items'       => array(
+                        'type' => 'string',
+                    ),
+                    'context'     => array( 'view' ),
+                    'readonly'    => true,
+                ),
+                'grouped_by'          => array(
+                    'description' => __( 'The period used to group the totals.', 'invoicing' ),
+                    'type'        => 'string',
+                    'context'     => array( 'view' ),
+                    'enum'        => array( 'day', 'month' ),
+                    'readonly'    => true,
+                ),
+                'currency'            => array(
+                    'description' => __( 'The default store currency.', 'invoicing' ),
+                    'type'        => 'string',
+                    'context'     => array( 'view' ),
+                    'readonly'    => true,
+                ),
+                'currency_symbol'     => array(
+                    'description' => __( 'The default store currency symbol.', 'invoicing' ),
+                    'type'        => 'string',
+                    'context'     => array( 'view' ),
+                    'readonly'    => true,
+                ),
+                'currency_position'   => array(
+                    'description' => __( 'The default store currency position.', 'invoicing' ),
+                    'type'        => 'string',
+                    'context'     => array( 'view' ),
+                    'readonly'    => true,
+                ),
+                'decimal_places'      => array(
+                    'description' => __( 'The default store decimal places.', 'invoicing' ),
+                    'type'        => 'string',
+                    'context'     => array( 'view' ),
+                    'readonly'    => true,
+                ),
+                'thousands_sep'       => array(
+                    'description' => __( 'The default store thousands separator.', 'invoicing' ),
+                    'type'        => 'string',
+                    'context'     => array( 'view' ),
+                    'readonly'    => true,
+                ),
+                'decimals_sep'        => array(
+                    'description' => __( 'The default store decimals separator.', 'invoicing' ),
+                    'type'        => 'string',
+                    'context'     => array( 'view' ),
+                    'readonly'    => true,
+                ),
+            ),
+        );
+
+        return $this->add_additional_fields_schema( $schema );
+
+    }
 
 }

includes/api/class-getpaid-rest-settings-controller.php

Indentation +743 added lines, -743 removed lines

@@ -18,756 +18,756 @@
  */
 class GetPaid_REST_Settings_Controller extends GetPaid_REST_Controller {
 
-	/**
-	 * An array of available settings.
-	 *
-	 * @var string
-	 */
-	protected $settings;
-
-	/**
-	 * Route base.
-	 *
-	 * @var string
-	 */
-	protected $rest_base = 'settings';
-
-	/**
-	 * Registers the routes for the objects of the controller.
-	 *
-	 * @since 2.0.0
-	 *
-	 * @see register_rest_route()
-	 */
-	public function register_namespace_routes( $namespace ) {
-
-		// List all registered tabs.
-		register_rest_route(
-			$namespace,
-			$this->rest_base,
-			array(
-				array(
-					'methods'             => WP_REST_Server::READABLE,
-					'callback'            => array( $this, 'get_tabs' ),
-					'permission_callback' => array( $this, 'get_items_permissions_check' ),
-				),
-				'schema' => '__return_empty_array',
-			)
-		);
-
-		// View/Update a single setting.
-		register_rest_route(
-			$namespace,
-			$this->rest_base . '/setting/(?P<id>[\w-]+)',
-			array(
-				'args'   => array(
-					'id' => array(
-						'description' => __( 'Unique identifier for the setting.', 'invoicing' ),
-						'type'        => 'string',
-						'required'    => true,
-					),
-				),
-				array(
-					'methods'             => WP_REST_Server::READABLE,
-					'callback'            => array( $this, 'get_item' ),
-					'permission_callback' => array( $this, 'get_items_permissions_check' ),
-				),
-				array(
-					'methods'             => WP_REST_Server::EDITABLE,
-					'callback'            => array( $this, 'update_item' ),
-					'permission_callback' => array( $this, 'update_items_permissions_check' ),
-					'args'                => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ),
-				),
-				'schema' => array( $this, 'get_public_item_schema' ),
-			)
-		);
-
-		// List registered sections for a given tab.
-		register_rest_route(
-			$namespace,
-			$this->rest_base . '/(?P<tab>[\w-]+)',
-			array(
-				'args'   => array(
-					'tab' => array(
-						'description' => __( 'Unique identifier for the tab whose sections should be retrieved.', 'invoicing' ),
-						'type'        => 'string',
-						'required'    => true,
-						'enum'        => array_keys( wpinv_get_settings_tabs() ),
-					),
-				),
-				array(
-					'methods'             => WP_REST_Server::READABLE,
-					'callback'            => array( $this, 'get_sections' ),
-					'permission_callback' => array( $this, 'get_items_permissions_check' ),
-				),
-				'schema' => '__return_empty_array',
-			)
-		);
-
-		// List all registered settings for a given tab.
-		register_rest_route(
-			$namespace,
-			$this->rest_base . '/(?P<tab>[\w-]+)/(?P<section>[\w-]+)',
-			array(
-				'args'   => array(
-					'tab'     => array(
-						'description' => __( 'Unique identifier for the tab whose settings should be retrieved.', 'invoicing' ),
-						'type'        => 'string',
-						'required'    => true,
-						'enum'        => array_keys( wpinv_get_settings_tabs() ),
-					),
-					'section' => array(
-						'description' => __( 'The section in the tab whose settings should be retrieved.', 'invoicing' ),
-						'type'        => 'string',
-						'required'    => true,
-					),
-				),
-				array(
-					'methods'             => WP_REST_Server::READABLE,
-					'callback'            => array( $this, 'get_items' ),
-					'permission_callback' => array( $this, 'get_items_permissions_check' ),
-				),
-				'schema' => array( $this, 'get_public_item_schema' ),
-			)
-		); 
-
-		register_rest_route(
-			$namespace,
-			'/' . $this->rest_base . '/batch',
-			array(
-				'args'   => array(
-					'id' => array(
-						'description' => __( 'Setting ID.', 'invoicing' ),
-						'type'        => 'string',
-					),
-				),
-				array(
-					'methods'             => WP_REST_Server::EDITABLE,
-					'callback'            => array( $this, 'batch_items' ),
-					'permission_callback' => array( $this, 'batch_items_permissions_check' ),
-					'args'                => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ),
-				),
-				'schema' => array( $this, 'get_public_batch_schema' ),
-			)
-		);
-
-	}
-
-	/**
-	 * Return all settings.
-	 *
-	 * @since  2.0.0
-	 * @param  WP_REST_Request $request Request data.
-	 * @return WP_Error|WP_REST_Response
-	 */
-	public function get_items( $request ) {
-
-		$settings = $this->get_settings();
-
-		if ( ! isset( $settings[ $request['tab'] ] ) ) {
-			return new WP_Error( 'rest_invalid_tab', __( 'Invalid tab.', 'invoicing' ), array( 'status' => 400 ) );
-		}
-
-		if ( ! isset( $settings[ $request['tab'] ][ $request['section'] ] ) ) {
-			return new WP_Error( 'rest_invalid_section', __( 'Invalid section.', 'invoicing' ), array( 'status' => 400 ) );
-		}
-
-		$settings = $settings[ $request['tab'] ][ $request['section'] ];
-		$prepared = array();
-
-		foreach ( $settings as $setting ) {
-
-			$setting      = $this->sanitize_setting( $setting );
-			$setting_data = $this->prepare_item_for_response( $setting, $request );
-			$setting_data = $this->prepare_response_for_collection( $setting_data );
-
-			if ( $this->is_setting_type_valid( $setting['type'] ) ) {
-				$prepared[]   = $setting_data;
-			}
+    /**
+     * An array of available settings.
+     *
+     * @var string
+     */
+    protected $settings;
+
+    /**
+     * Route base.
+     *
+     * @var string
+     */
+    protected $rest_base = 'settings';
+
+    /**
+     * Registers the routes for the objects of the controller.
+     *
+     * @since 2.0.0
+     *
+     * @see register_rest_route()
+     */
+    public function register_namespace_routes( $namespace ) {
+
+        // List all registered tabs.
+        register_rest_route(
+            $namespace,
+            $this->rest_base,
+            array(
+                array(
+                    'methods'             => WP_REST_Server::READABLE,
+                    'callback'            => array( $this, 'get_tabs' ),
+                    'permission_callback' => array( $this, 'get_items_permissions_check' ),
+                ),
+                'schema' => '__return_empty_array',
+            )
+        );
+
+        // View/Update a single setting.
+        register_rest_route(
+            $namespace,
+            $this->rest_base . '/setting/(?P<id>[\w-]+)',
+            array(
+                'args'   => array(
+                    'id' => array(
+                        'description' => __( 'Unique identifier for the setting.', 'invoicing' ),
+                        'type'        => 'string',
+                        'required'    => true,
+                    ),
+                ),
+                array(
+                    'methods'             => WP_REST_Server::READABLE,
+                    'callback'            => array( $this, 'get_item' ),
+                    'permission_callback' => array( $this, 'get_items_permissions_check' ),
+                ),
+                array(
+                    'methods'             => WP_REST_Server::EDITABLE,
+                    'callback'            => array( $this, 'update_item' ),
+                    'permission_callback' => array( $this, 'update_items_permissions_check' ),
+                    'args'                => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ),
+                ),
+                'schema' => array( $this, 'get_public_item_schema' ),
+            )
+        );
+
+        // List registered sections for a given tab.
+        register_rest_route(
+            $namespace,
+            $this->rest_base . '/(?P<tab>[\w-]+)',
+            array(
+                'args'   => array(
+                    'tab' => array(
+                        'description' => __( 'Unique identifier for the tab whose sections should be retrieved.', 'invoicing' ),
+                        'type'        => 'string',
+                        'required'    => true,
+                        'enum'        => array_keys( wpinv_get_settings_tabs() ),
+                    ),
+                ),
+                array(
+                    'methods'             => WP_REST_Server::READABLE,
+                    'callback'            => array( $this, 'get_sections' ),
+                    'permission_callback' => array( $this, 'get_items_permissions_check' ),
+                ),
+                'schema' => '__return_empty_array',
+            )
+        );
+
+        // List all registered settings for a given tab.
+        register_rest_route(
+            $namespace,
+            $this->rest_base . '/(?P<tab>[\w-]+)/(?P<section>[\w-]+)',
+            array(
+                'args'   => array(
+                    'tab'     => array(
+                        'description' => __( 'Unique identifier for the tab whose settings should be retrieved.', 'invoicing' ),
+                        'type'        => 'string',
+                        'required'    => true,
+                        'enum'        => array_keys( wpinv_get_settings_tabs() ),
+                    ),
+                    'section' => array(
+                        'description' => __( 'The section in the tab whose settings should be retrieved.', 'invoicing' ),
+                        'type'        => 'string',
+                        'required'    => true,
+                    ),
+                ),
+                array(
+                    'methods'             => WP_REST_Server::READABLE,
+                    'callback'            => array( $this, 'get_items' ),
+                    'permission_callback' => array( $this, 'get_items_permissions_check' ),
+                ),
+                'schema' => array( $this, 'get_public_item_schema' ),
+            )
+        ); 
+
+        register_rest_route(
+            $namespace,
+            '/' . $this->rest_base . '/batch',
+            array(
+                'args'   => array(
+                    'id' => array(
+                        'description' => __( 'Setting ID.', 'invoicing' ),
+                        'type'        => 'string',
+                    ),
+                ),
+                array(
+                    'methods'             => WP_REST_Server::EDITABLE,
+                    'callback'            => array( $this, 'batch_items' ),
+                    'permission_callback' => array( $this, 'batch_items_permissions_check' ),
+                    'args'                => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ),
+                ),
+                'schema' => array( $this, 'get_public_batch_schema' ),
+            )
+        );
+
+    }
+
+    /**
+     * Return all settings.
+     *
+     * @since  2.0.0
+     * @param  WP_REST_Request $request Request data.
+     * @return WP_Error|WP_REST_Response
+     */
+    public function get_items( $request ) {
+
+        $settings = $this->get_settings();
+
+        if ( ! isset( $settings[ $request['tab'] ] ) ) {
+            return new WP_Error( 'rest_invalid_tab', __( 'Invalid tab.', 'invoicing' ), array( 'status' => 400 ) );
+        }
+
+        if ( ! isset( $settings[ $request['tab'] ][ $request['section'] ] ) ) {
+            return new WP_Error( 'rest_invalid_section', __( 'Invalid section.', 'invoicing' ), array( 'status' => 400 ) );
+        }
+
+        $settings = $settings[ $request['tab'] ][ $request['section'] ];
+        $prepared = array();
+
+        foreach ( $settings as $setting ) {
+
+            $setting      = $this->sanitize_setting( $setting );
+            $setting_data = $this->prepare_item_for_response( $setting, $request );
+            $setting_data = $this->prepare_response_for_collection( $setting_data );
+
+            if ( $this->is_setting_type_valid( $setting['type'] ) ) {
+                $prepared[]   = $setting_data;
+            }
 }
 
-		return rest_ensure_response( $prepared );
-	}
-
-	/**
-	 * Return a single setting.
-	 *
-	 * @since  2.0.0
-	 * @param  WP_REST_Request $request Request data.
-	 * @return WP_Error|WP_REST_Response
-	 */
-	public function get_item( $request ) {
-		$setting  = $this->get_setting( $request['id'] );
-
-		if ( is_wp_error( $setting ) ) {
-			return $setting;
-		}
-
-		$setting  = $this->sanitize_setting( $setting );
-		$response = $this->prepare_item_for_response( $setting, $request );
-		return rest_ensure_response( $response );
-	}
-
-	/**
-	 * Update a single setting.
-	 *
-	 * @since  2.0.0
-	 * @param  WP_REST_Request $request Request data.
-	 * @return WP_Error|WP_REST_Response
-	 */
-	public function update_item( $request ) {
-		$setting = $this->get_setting( $request['id'] );
-
-		if ( is_wp_error( $setting ) ) {
-			return $setting;
-		}
-
-		if ( is_callable( array( $this, 'validate_setting_' . $setting['type'] . '_field' ) ) ) {
-			$value = $this->{'validate_setting_' . $setting['type'] . '_field'}( $request['value'], $setting );
-		} else {
-			$value = $this->validate_setting_text_field( $request['value'], $setting );
-		}
-
-		if ( is_wp_error( $value ) ) {
-			return $value;
-		}
-
-		wpinv_update_option( $request['id'], $value );
-		$setting['value'] = $value;
-		$setting          = $this->sanitize_setting( $setting );
-		$response         = $this->prepare_item_for_response( $setting, $request );
-
-		return rest_ensure_response( $response );
-	}
-
-	/**
-	 * Makes sure the current user has access to READ the settings APIs.
-	 *
-	 * @since  2.0.0
-	 * @param WP_REST_Request $request Full data about the request.
-	 * @return WP_Error|boolean
-	 */
-	public function get_items_permissions_check( $request ) {
-		if ( ! wpinv_current_user_can_manage_invoicing() ) {
-			return new WP_Error( 'rest_cannot_view', __( 'Sorry, you cannot list resources.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) );
-		}
-
-		return true;
-	}
-
-	/**
-	 * Makes sure the current user has access to WRITE the settings APIs.
-	 *
-	 * @since  2.0.0
-	 * @param WP_REST_Request $request Full data about the request.
-	 * @return WP_Error|boolean
-	 */
-	public function update_items_permissions_check( $request ) {
-		if ( ! wpinv_current_user_can_manage_invoicing() ) {
-			return new WP_Error( 'rest_cannot_edit', __( 'Sorry, you cannot edit this resource.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) );
-		}
-
-		return true;
-	}
-
-	/**
-	 * Check if a given request has access batch create, update and delete items.
-	 *
-	 * @param  WP_REST_Request $request Full details about the request.
-	 *
-	 * @return boolean|WP_Error
-	 */
-	public function batch_items_permissions_check( $request ) {
-		return wpinv_current_user_can_manage_invoicing() ? true : new WP_Error( 'rest_cannot_batch', __( 'Sorry, you are not allowed to batch manipulate this resource.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) );
-	}
-
-	/**
-	 * Prepare links for the request.
-	 *
-	 * @param string $setting_id Setting ID.
-	 * @return array Links for the given setting.
-	 */
-	protected function prepare_links( $setting_id ) {
-
-		$links = array(
-			'self'       => array(
-				'href' => rest_url( sprintf( '/%s/%s/setting/%s', $this->namespace, $this->rest_base, $setting_id ) ),
-			),
-			'collection' => array(
-				'href' => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ),
-			),
-		);
-
-		return $links;
-	}
-
-	/**
-	 * Prepare a settings object for serialization.
-	 *
-	 * @since  2.0.0
-	 * @param array           $item Setting object.
-	 * @param WP_REST_Request $request Request object.
-	 * @return WP_REST_Response $response Response data.
-	 */
-	public function prepare_item_for_response( $item, $request ) {
-		$context = empty( $request['context'] ) ? 'view' : $request['context'];
-		$data    = $this->add_additional_fields_to_object( $item, $request );
-		$data    = $this->filter_response_by_context( $data, $context );
-
-		$response = rest_ensure_response( $data );
-
-		$response->add_links( $this->prepare_links( $item['id'] ) );
-
-		return $response;
-	}
-
-	/**
-	 * Filters out bad values from the settings array/filter so we
-	 * only return known values via the API.
-	 *
-	 * @since 2.0.0
-	 * @param  array $setting Setting.
-	 * @return array
-	 */
-	public function filter_setting( $setting ) {
-		return array_intersect_key(
-			$setting,
-			array_flip( array_filter( array_keys( $setting ), array( $this, 'allowed_setting_keys' ) ) )
-		);
-	}
-
-	/**
-	 * Callback for allowed keys for each setting response.
-	 *
-	 * @param  string $key Key to check.
-	 * @return boolean
-	 */
-	public function allowed_setting_keys( $key ) {
-		return in_array( $key, array_keys( $this->setting_defaults() ), true );
-	}
-
-	/**
-	 * Returns default options for a setting. null means the field is required.
-	 *
-	 * @since  2.0.0
-	 * @return array
-	 */
-	protected function setting_defaults() {
-		return array(
-			'id'          => null,
-			'name'        => null,
-			'desc'        => '',
-			'options'     => array(),
-			'std'         => false,
-			'value'       => false,
-			'placeholder' => '',
-			'readonly'    => false,
-			'faux'        => false,
-			'section'     => 'main',
-			'tab'         => 'general',
-			'type'        => 'text',
-		);
-	}
-
-	/**
-	 * Sanitizes a setting's field.
-	 *
-	 * @param  array $setting The setting to sanitize.
-	 * @return array
-	 */
-	public function sanitize_setting( $setting ) {
-
-		$setting          = wp_parse_args( $setting, $this->setting_defaults() );
-		$setting['value'] = wpinv_get_option( $setting['id'], $setting['std'] );
-		return $this->filter_setting( $setting );
-
-	}
-
-	/**
-	 * Get setting data.
-	 *
-	 * @since  2.0.0
-	 * @param string $setting_id Setting ID.
-	 * @return array|WP_Error
-	 */
-	public function get_setting( $setting_id ) {
-
-		if ( empty( $setting_id ) ) {
-			return new WP_Error( 'rest_setting_setting_invalid', __( 'Invalid setting.', 'invoicing' ), array( 'status' => 404 ) );
-		}
-
-		$settings  = $this->get_settings();
-
-		foreach ( $settings as $tabs ) {
-
-			foreach ( $tabs as $sections ) {
-
-				if ( isset( $sections[ $setting_id ] ) ) {
-					if ( ! $this->is_setting_type_valid( $sections[ $setting_id ]['type'] ) ) {
-						return new WP_Error( 'rest_setting_setting_type_invalid', __( 'Invalid setting type.', 'invoicing' ), array( 'status' => 404 ) );
-					}
-
-					return $sections[ $setting_id ];
-				}
+        return rest_ensure_response( $prepared );
+    }
+
+    /**
+     * Return a single setting.
+     *
+     * @since  2.0.0
+     * @param  WP_REST_Request $request Request data.
+     * @return WP_Error|WP_REST_Response
+     */
+    public function get_item( $request ) {
+        $setting  = $this->get_setting( $request['id'] );
+
+        if ( is_wp_error( $setting ) ) {
+            return $setting;
+        }
+
+        $setting  = $this->sanitize_setting( $setting );
+        $response = $this->prepare_item_for_response( $setting, $request );
+        return rest_ensure_response( $response );
+    }
+
+    /**
+     * Update a single setting.
+     *
+     * @since  2.0.0
+     * @param  WP_REST_Request $request Request data.
+     * @return WP_Error|WP_REST_Response
+     */
+    public function update_item( $request ) {
+        $setting = $this->get_setting( $request['id'] );
+
+        if ( is_wp_error( $setting ) ) {
+            return $setting;
+        }
+
+        if ( is_callable( array( $this, 'validate_setting_' . $setting['type'] . '_field' ) ) ) {
+            $value = $this->{'validate_setting_' . $setting['type'] . '_field'}( $request['value'], $setting );
+        } else {
+            $value = $this->validate_setting_text_field( $request['value'], $setting );
+        }
+
+        if ( is_wp_error( $value ) ) {
+            return $value;
+        }
+
+        wpinv_update_option( $request['id'], $value );
+        $setting['value'] = $value;
+        $setting          = $this->sanitize_setting( $setting );
+        $response         = $this->prepare_item_for_response( $setting, $request );
+
+        return rest_ensure_response( $response );
+    }
+
+    /**
+     * Makes sure the current user has access to READ the settings APIs.
+     *
+     * @since  2.0.0
+     * @param WP_REST_Request $request Full data about the request.
+     * @return WP_Error|boolean
+     */
+    public function get_items_permissions_check( $request ) {
+        if ( ! wpinv_current_user_can_manage_invoicing() ) {
+            return new WP_Error( 'rest_cannot_view', __( 'Sorry, you cannot list resources.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) );
+        }
+
+        return true;
+    }
+
+    /**
+     * Makes sure the current user has access to WRITE the settings APIs.
+     *
+     * @since  2.0.0
+     * @param WP_REST_Request $request Full data about the request.
+     * @return WP_Error|boolean
+     */
+    public function update_items_permissions_check( $request ) {
+        if ( ! wpinv_current_user_can_manage_invoicing() ) {
+            return new WP_Error( 'rest_cannot_edit', __( 'Sorry, you cannot edit this resource.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) );
+        }
+
+        return true;
+    }
+
+    /**
+     * Check if a given request has access batch create, update and delete items.
+     *
+     * @param  WP_REST_Request $request Full details about the request.
+     *
+     * @return boolean|WP_Error
+     */
+    public function batch_items_permissions_check( $request ) {
+        return wpinv_current_user_can_manage_invoicing() ? true : new WP_Error( 'rest_cannot_batch', __( 'Sorry, you are not allowed to batch manipulate this resource.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) );
+    }
+
+    /**
+     * Prepare links for the request.
+     *
+     * @param string $setting_id Setting ID.
+     * @return array Links for the given setting.
+     */
+    protected function prepare_links( $setting_id ) {
+
+        $links = array(
+            'self'       => array(
+                'href' => rest_url( sprintf( '/%s/%s/setting/%s', $this->namespace, $this->rest_base, $setting_id ) ),
+            ),
+            'collection' => array(
+                'href' => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ),
+            ),
+        );
+
+        return $links;
+    }
+
+    /**
+     * Prepare a settings object for serialization.
+     *
+     * @since  2.0.0
+     * @param array           $item Setting object.
+     * @param WP_REST_Request $request Request object.
+     * @return WP_REST_Response $response Response data.
+     */
+    public function prepare_item_for_response( $item, $request ) {
+        $context = empty( $request['context'] ) ? 'view' : $request['context'];
+        $data    = $this->add_additional_fields_to_object( $item, $request );
+        $data    = $this->filter_response_by_context( $data, $context );
+
+        $response = rest_ensure_response( $data );
+
+        $response->add_links( $this->prepare_links( $item['id'] ) );
+
+        return $response;
+    }
+
+    /**
+     * Filters out bad values from the settings array/filter so we
+     * only return known values via the API.
+     *
+     * @since 2.0.0
+     * @param  array $setting Setting.
+     * @return array
+     */
+    public function filter_setting( $setting ) {
+        return array_intersect_key(
+            $setting,
+            array_flip( array_filter( array_keys( $setting ), array( $this, 'allowed_setting_keys' ) ) )
+        );
+    }
+
+    /**
+     * Callback for allowed keys for each setting response.
+     *
+     * @param  string $key Key to check.
+     * @return boolean
+     */
+    public function allowed_setting_keys( $key ) {
+        return in_array( $key, array_keys( $this->setting_defaults() ), true );
+    }
+
+    /**
+     * Returns default options for a setting. null means the field is required.
+     *
+     * @since  2.0.0
+     * @return array
+     */
+    protected function setting_defaults() {
+        return array(
+            'id'          => null,
+            'name'        => null,
+            'desc'        => '',
+            'options'     => array(),
+            'std'         => false,
+            'value'       => false,
+            'placeholder' => '',
+            'readonly'    => false,
+            'faux'        => false,
+            'section'     => 'main',
+            'tab'         => 'general',
+            'type'        => 'text',
+        );
+    }
+
+    /**
+     * Sanitizes a setting's field.
+     *
+     * @param  array $setting The setting to sanitize.
+     * @return array
+     */
+    public function sanitize_setting( $setting ) {
+
+        $setting          = wp_parse_args( $setting, $this->setting_defaults() );
+        $setting['value'] = wpinv_get_option( $setting['id'], $setting['std'] );
+        return $this->filter_setting( $setting );
+
+    }
+
+    /**
+     * Get setting data.
+     *
+     * @since  2.0.0
+     * @param string $setting_id Setting ID.
+     * @return array|WP_Error
+     */
+    public function get_setting( $setting_id ) {
+
+        if ( empty( $setting_id ) ) {
+            return new WP_Error( 'rest_setting_setting_invalid', __( 'Invalid setting.', 'invoicing' ), array( 'status' => 404 ) );
+        }
+
+        $settings  = $this->get_settings();
+
+        foreach ( $settings as $tabs ) {
+
+            foreach ( $tabs as $sections ) {
+
+                if ( isset( $sections[ $setting_id ] ) ) {
+                    if ( ! $this->is_setting_type_valid( $sections[ $setting_id ]['type'] ) ) {
+                        return new WP_Error( 'rest_setting_setting_type_invalid', __( 'Invalid setting type.', 'invoicing' ), array( 'status' => 404 ) );
+                    }
+
+                    return $sections[ $setting_id ];
+                }
 }
 }
 
-		return new WP_Error( 'rest_setting_setting_invalid', __( 'Invalid setting.', 'invoicing' ), array( 'status' => 404 ) );
-	}
-
-	/**
-	 * Get all tabs.
-	 *
-	 * @param  WP_REST_Request $request Request data.
-	 * @return array
-	 */
-	public function get_tabs( $request ) {
-		$tabs     = wpinv_get_settings_tabs();
-		$prepared = array();
-
-		foreach ( $tabs as $id => $tab ) {
-
-			$_request        = $request;
-			$_request['tab'] = sanitize_title( $id );
-			$data            = array(
-				'id'       => sanitize_title( $id ),
-				'label'    => sanitize_text_field( $tab ),
-				'sections' => $this->get_sections( $_request ),
-			);
-
-			$data     = $this->add_additional_fields_to_object( $data, $request );
-			$response = rest_ensure_response( $data );
-
-			if ( ! is_wp_error( $response ) ) {
-				$links = array(
-					'sections'   => array(
-						'href' => rest_url( sprintf( '/%s/%s/%s', $this->namespace, $this->rest_base, $id ) ),
-					),
-					'collection' => array(
-						'href' => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ),
-					),
-				);
-				$response->add_links( $links );
-				$response = $this->prepare_response_for_collection( $response );
-			}
-
-			$prepared[] = $response;
-
-		}
-
-		return rest_ensure_response( $prepared );
-	}
-
-	/**
-	 * Get all sections.
-	 *
-	 * @param  WP_REST_Request $request Request data.
-	 * @return array
-	 */
-	public function get_sections( $request ) {
-
-		$tab      = sanitize_title( $request['tab'] );
-		$sections = wpinv_get_settings_tab_sections( $tab );
-		$prepared = array();
-
-		foreach ( $sections as $id => $section ) {
-
-			$data            = array(
-				'id'    => sanitize_title( $id ),
-				'label' => sanitize_text_field( $section ),
-			);
-
-			$data     = $this->add_additional_fields_to_object( $data, $request );
-			$response = rest_ensure_response( $data );
-
-			if ( ! is_wp_error( $response ) ) {
-				$links = array(
-					'settings'   => array(
-						'href' => rest_url( sprintf( '/%s/%s/%s/%s', $this->namespace, $this->rest_base, $tab, $id ) ),
-					),
-					'collection' => array(
-						'href' => rest_url( sprintf( '/%s/%s/%s', $this->namespace, $this->rest_base, $tab ) ),
-					),
-					'tabs'       => array(
-						'href' => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ),
-					),
-				);
-				$response->add_links( $links );
-				$response = $this->prepare_response_for_collection( $response );
-			}
-
-			$prepared[] = $response;
-
-		}
-
-		return rest_ensure_response( $prepared );
-	}
-
-	/**
-	 * Get all settings.
-	 *
-	 * @return array
-	 */
-	public function get_settings() {
-
-		if ( empty( $this->settings ) ) {
-			$this->settings = wpinv_get_registered_settings();
-		}
-
-		return $this->settings;
-
-	}
-
-	/**
-	 * Boolean for if a setting type is a valid supported setting type.
-	 *
-	 * @since  2.0.0
-	 * @param  string $type Type.
-	 * @return bool
-	 */
-	public function is_setting_type_valid( $type ) {
-
-		return in_array(
-			$type,
+        return new WP_Error( 'rest_setting_setting_invalid', __( 'Invalid setting.', 'invoicing' ), array( 'status' => 404 ) );
+    }
+
+    /**
+     * Get all tabs.
+     *
+     * @param  WP_REST_Request $request Request data.
+     * @return array
+     */
+    public function get_tabs( $request ) {
+        $tabs     = wpinv_get_settings_tabs();
+        $prepared = array();
+
+        foreach ( $tabs as $id => $tab ) {
+
+            $_request        = $request;
+            $_request['tab'] = sanitize_title( $id );
+            $data            = array(
+                'id'       => sanitize_title( $id ),
+                'label'    => sanitize_text_field( $tab ),
+                'sections' => $this->get_sections( $_request ),
+            );
+
+            $data     = $this->add_additional_fields_to_object( $data, $request );
+            $response = rest_ensure_response( $data );
+
+            if ( ! is_wp_error( $response ) ) {
+                $links = array(
+                    'sections'   => array(
+                        'href' => rest_url( sprintf( '/%s/%s/%s', $this->namespace, $this->rest_base, $id ) ),
+                    ),
+                    'collection' => array(
+                        'href' => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ),
+                    ),
+                );
+                $response->add_links( $links );
+                $response = $this->prepare_response_for_collection( $response );
+            }
+
+            $prepared[] = $response;
+
+        }
+
+        return rest_ensure_response( $prepared );
+    }
+
+    /**
+     * Get all sections.
+     *
+     * @param  WP_REST_Request $request Request data.
+     * @return array
+     */
+    public function get_sections( $request ) {
+
+        $tab      = sanitize_title( $request['tab'] );
+        $sections = wpinv_get_settings_tab_sections( $tab );
+        $prepared = array();
+
+        foreach ( $sections as $id => $section ) {
+
+            $data            = array(
+                'id'    => sanitize_title( $id ),
+                'label' => sanitize_text_field( $section ),
+            );
+
+            $data     = $this->add_additional_fields_to_object( $data, $request );
+            $response = rest_ensure_response( $data );
+
+            if ( ! is_wp_error( $response ) ) {
+                $links = array(
+                    'settings'   => array(
+                        'href' => rest_url( sprintf( '/%s/%s/%s/%s', $this->namespace, $this->rest_base, $tab, $id ) ),
+                    ),
+                    'collection' => array(
+                        'href' => rest_url( sprintf( '/%s/%s/%s', $this->namespace, $this->rest_base, $tab ) ),
+                    ),
+                    'tabs'       => array(
+                        'href' => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ),
+                    ),
+                );
+                $response->add_links( $links );
+                $response = $this->prepare_response_for_collection( $response );
+            }
+
+            $prepared[] = $response;
+
+        }
+
+        return rest_ensure_response( $prepared );
+    }
+
+    /**
+     * Get all settings.
+     *
+     * @return array
+     */
+    public function get_settings() {
+
+        if ( empty( $this->settings ) ) {
+            $this->settings = wpinv_get_registered_settings();
+        }
+
+        return $this->settings;
+
+    }
+
+    /**
+     * Boolean for if a setting type is a valid supported setting type.
+     *
+     * @since  2.0.0
+     * @param  string $type Type.
+     * @return bool
+     */
+    public function is_setting_type_valid( $type ) {
+
+        return in_array(
+            $type,
             array(
-				'text',         // Validates with validate_setting_text_field.
-				'email',        // Validates with validate_setting_text_field.
-				'number',       // Validates with validate_setting_text_field.
-				'color',        // Validates with validate_setting_text_field.
-				'password',     // Validates with validate_setting_text_field.
-				'textarea',     // Validates with validate_setting_textarea_field.
-				'select',       // Validates with validate_setting_select_field.
-				'multiselect',  // Validates with validate_setting_multiselect_field.
-				'radio',        // Validates with validate_setting_radio_field (-> validate_setting_select_field).
-				'checkbox',     // Validates with validate_setting_checkbox_field.
-				'header',       // Validates with validate_setting_text_field.
-			)
-		);
-
-	}
-
-	/**
-	 * Get the settings schema, conforming to JSON Schema.
-	 *
-	 * @return array
-	 */
-	public function get_item_schema() {
-
-		// Maybe retrieve the schema from cache.
-		if ( ! empty( $this->schema ) ) {
-			return $this->add_additional_fields_schema( $this->schema );
-		}
-
-		$schema = array(
-			'$schema'    => 'http://json-schema.org/draft-04/schema#',
-			'title'      => 'setting',
-			'type'       => 'object',
-			'properties' => array(
-				'id'          => array(
-					'description' => __( 'A unique identifier for the setting.', 'invoicing' ),
-					'type'        => 'string',
-					'arg_options' => array(
-						'sanitize_callback' => 'sanitize_title',
-					),
-					'context'     => array( 'view', 'edit' ),
-					'readonly'    => true,
-				),
-				'tab'         => array(
-					'description' => __( 'An identifier for the tab this setting belongs to.', 'invoicing' ),
-					'type'        => 'string',
-					'arg_options' => array(
-						'sanitize_callback' => 'sanitize_title',
-					),
-					'context'     => array( 'view', 'edit' ),
-					'readonly'    => true,
-				),
-				'section'     => array(
-					'description' => __( 'An identifier for the section this setting belongs to.', 'invoicing' ),
-					'type'        => 'string',
-					'arg_options' => array(
-						'sanitize_callback' => 'sanitize_title',
-					),
-					'context'     => array( 'view', 'edit' ),
-					'readonly'    => true,
-				),
-				'name'        => array(
-					'description' => __( 'A human readable label for the setting used in interfaces.', 'invoicing' ),
-					'type'        => 'string',
-					'arg_options' => array(
-						'sanitize_callback' => 'sanitize_text_field',
-					),
-					'context'     => array( 'view', 'edit' ),
-					'readonly'    => true,
-				),
-				'desc'        => array(
-					'description' => __( 'A human readable description for the setting used in interfaces.', 'invoicing' ),
-					'type'        => 'string',
-					'context'     => array( 'view', 'edit' ),
-					'readonly'    => true,
-				),
-				'value'       => array(
-					'description' => __( 'The current value of this setting.', 'invoicing' ),
-					'type'        => 'mixed',
-					'context'     => array( 'view', 'edit' ),
-				),
-				'default'     => array(
-					'description' => __( 'Default value for the setting.', 'invoicing' ),
-					'type'        => 'mixed',
-					'context'     => array( 'view', 'edit' ),
-					'readonly'    => true,
-				),
-				'placeholder' => array(
-					'description' => __( 'Placeholder text to be displayed in text inputs.', 'invoicing' ),
-					'type'        => 'string',
-					'arg_options' => array(
-						'sanitize_callback' => 'sanitize_text_field',
-					),
-					'context'     => array( 'view', 'edit' ),
-					'readonly'    => true,
-				),
-				'type'        => array(
-					'description' => __( 'Type of setting.', 'invoicing' ),
-					'type'        => 'string',
-					'arg_options' => array(
-						'sanitize_callback' => 'sanitize_text_field',
-					),
-					'context'     => array( 'view', 'edit' ),
-					'enum'        => array( 'text', 'email', 'number', 'color', 'password', 'textarea', 'select', 'multiselect', 'radio', 'image_width', 'checkbox', 'raw_html' ),
-					'readonly'    => true,
-				),
-				'options'     => array(
-					'description' => __( 'Array of options (key value pairs) for inputs such as select, multiselect, and radio buttons.', 'invoicing' ),
-					'type'        => 'object',
-					'context'     => array( 'view', 'edit' ),
-					'readonly'    => true,
-				),
-				'readonly'    => array(
-					'description' => __( 'Whether or not this setting is readonly', 'invoicing' ),
-					'type'        => 'string',
-					'context'     => array( 'view' ),
-					'readonly'    => true,
-				),
-				'faux'        => array(
-					'description' => __( 'Whether or not this setting is readonly/faux', 'invoicing' ),
-					'type'        => 'string',
-					'context'     => array( 'view' ),
-					'readonly'    => true,
-				),
-			),
-		);
-
-		// Filters the settings schema for the REST API.
+                'text',         // Validates with validate_setting_text_field.
+                'email',        // Validates with validate_setting_text_field.
+                'number',       // Validates with validate_setting_text_field.
+                'color',        // Validates with validate_setting_text_field.
+                'password',     // Validates with validate_setting_text_field.
+                'textarea',     // Validates with validate_setting_textarea_field.
+                'select',       // Validates with validate_setting_select_field.
+                'multiselect',  // Validates with validate_setting_multiselect_field.
+                'radio',        // Validates with validate_setting_radio_field (-> validate_setting_select_field).
+                'checkbox',     // Validates with validate_setting_checkbox_field.
+                'header',       // Validates with validate_setting_text_field.
+            )
+        );
+
+    }
+
+    /**
+     * Get the settings schema, conforming to JSON Schema.
+     *
+     * @return array
+     */
+    public function get_item_schema() {
+
+        // Maybe retrieve the schema from cache.
+        if ( ! empty( $this->schema ) ) {
+            return $this->add_additional_fields_schema( $this->schema );
+        }
+
+        $schema = array(
+            '$schema'    => 'http://json-schema.org/draft-04/schema#',
+            'title'      => 'setting',
+            'type'       => 'object',
+            'properties' => array(
+                'id'          => array(
+                    'description' => __( 'A unique identifier for the setting.', 'invoicing' ),
+                    'type'        => 'string',
+                    'arg_options' => array(
+                        'sanitize_callback' => 'sanitize_title',
+                    ),
+                    'context'     => array( 'view', 'edit' ),
+                    'readonly'    => true,
+                ),
+                'tab'         => array(
+                    'description' => __( 'An identifier for the tab this setting belongs to.', 'invoicing' ),
+                    'type'        => 'string',
+                    'arg_options' => array(
+                        'sanitize_callback' => 'sanitize_title',
+                    ),
+                    'context'     => array( 'view', 'edit' ),
+                    'readonly'    => true,
+                ),
+                'section'     => array(
+                    'description' => __( 'An identifier for the section this setting belongs to.', 'invoicing' ),
+                    'type'        => 'string',
+                    'arg_options' => array(
+                        'sanitize_callback' => 'sanitize_title',
+                    ),
+                    'context'     => array( 'view', 'edit' ),
+                    'readonly'    => true,
+                ),
+                'name'        => array(
+                    'description' => __( 'A human readable label for the setting used in interfaces.', 'invoicing' ),
+                    'type'        => 'string',
+                    'arg_options' => array(
+                        'sanitize_callback' => 'sanitize_text_field',
+                    ),
+                    'context'     => array( 'view', 'edit' ),
+                    'readonly'    => true,
+                ),
+                'desc'        => array(
+                    'description' => __( 'A human readable description for the setting used in interfaces.', 'invoicing' ),
+                    'type'        => 'string',
+                    'context'     => array( 'view', 'edit' ),
+                    'readonly'    => true,
+                ),
+                'value'       => array(
+                    'description' => __( 'The current value of this setting.', 'invoicing' ),
+                    'type'        => 'mixed',
+                    'context'     => array( 'view', 'edit' ),
+                ),
+                'default'     => array(
+                    'description' => __( 'Default value for the setting.', 'invoicing' ),
+                    'type'        => 'mixed',
+                    'context'     => array( 'view', 'edit' ),
+                    'readonly'    => true,
+                ),
+                'placeholder' => array(
+                    'description' => __( 'Placeholder text to be displayed in text inputs.', 'invoicing' ),
+                    'type'        => 'string',
+                    'arg_options' => array(
+                        'sanitize_callback' => 'sanitize_text_field',
+                    ),
+                    'context'     => array( 'view', 'edit' ),
+                    'readonly'    => true,
+                ),
+                'type'        => array(
+                    'description' => __( 'Type of setting.', 'invoicing' ),
+                    'type'        => 'string',
+                    'arg_options' => array(
+                        'sanitize_callback' => 'sanitize_text_field',
+                    ),
+                    'context'     => array( 'view', 'edit' ),
+                    'enum'        => array( 'text', 'email', 'number', 'color', 'password', 'textarea', 'select', 'multiselect', 'radio', 'image_width', 'checkbox', 'raw_html' ),
+                    'readonly'    => true,
+                ),
+                'options'     => array(
+                    'description' => __( 'Array of options (key value pairs) for inputs such as select, multiselect, and radio buttons.', 'invoicing' ),
+                    'type'        => 'object',
+                    'context'     => array( 'view', 'edit' ),
+                    'readonly'    => true,
+                ),
+                'readonly'    => array(
+                    'description' => __( 'Whether or not this setting is readonly', 'invoicing' ),
+                    'type'        => 'string',
+                    'context'     => array( 'view' ),
+                    'readonly'    => true,
+                ),
+                'faux'        => array(
+                    'description' => __( 'Whether or not this setting is readonly/faux', 'invoicing' ),
+                    'type'        => 'string',
+                    'context'     => array( 'view' ),
+                    'readonly'    => true,
+                ),
+            ),
+        );
+
+        // Filters the settings schema for the REST API.
         $schema = apply_filters( 'getpaid_rest_settings_schema', $schema );
 
-		// Cache the settings schema.
-		$this->schema = $schema;
-
-		return $this->add_additional_fields_schema( $this->schema );
-
-	}
-
-	/**
-	 * Validate a text value for a text based setting.
-	 *
-	 * @since 2.0.0
-	 * @param string $value Value.
-	 * @param array  $setting Setting.
-	 * @return string
-	 */
-	public function validate_setting_text_field( $value ) {
-		$value = is_null( $value ) ? '' : $value;
-		return wp_kses_post( trim( stripslashes( $value ) ) );
-	}
-
-	/**
-	 * Validate select based settings.
-	 *
-	 * @since 2.0.0
-	 * @param string $value Value.
-	 * @param array  $setting Setting.
-	 * @return string|WP_Error
-	 */
-	public function validate_setting_select_field( $value, $setting ) {
-		if ( array_key_exists( $value, $setting['options'] ) ) {
-			return $value;
-		} else {
-			return new WP_Error( 'rest_setting_value_invalid', __( 'An invalid setting value was passed.', 'invoicing' ), array( 'status' => 400 ) );
-		}
-	}
-
-	/**
-	 * Validate multiselect based settings.
-	 *
-	 * @since 2.0.0
-	 * @param array $values Values.
-	 * @param array $setting Setting.
-	 * @return array|WP_Error
-	 */
-	public function validate_setting_multiselect_field( $values, $setting ) {
-		if ( empty( $values ) ) {
-			return array();
-		}
-
-		if ( ! is_array( $values ) ) {
-			return new WP_Error( 'rest_setting_value_invalid', __( 'An invalid setting value was passed.', 'invoicing' ), array( 'status' => 400 ) );
-		}
-
-		$final_values = array();
-		foreach ( $values as $value ) {
-			if ( array_key_exists( $value, $setting['options'] ) ) {
-				$final_values[] = $value;
-			}
-		}
-
-		return $final_values;
-	}
-
-	/**
-	 * Validate radio based settings.
-	 *
-	 * @since 2.0.0
-	 * @param string $value Value.
-	 * @param array  $setting Setting.
-	 * @return string|WP_Error
-	 */
-	public function validate_setting_radio_field( $value, $setting ) {
-		return $this->validate_setting_select_field( $value, $setting );
-	}
-
-	/**
-	 * Validate checkbox based settings.
-	 *
-	 * @since 2.0.0
-	 * @param string $value Value.
-	 * @return int
-	 */
-	public function validate_setting_checkbox_field( $value ) {
-		return (int) ! empty( $value );
-	}
-
-	/**
-	 * Validate textarea based settings.
-	 *
-	 * @since 2.0.0
-	 * @param string $value Value.
-	 * @return string
-	 */
-	public function validate_setting_textarea_field( $value ) {
-		$value = is_null( $value ) ? '' : $value;
-		return wp_kses(
-			trim( stripslashes( $value ) ),
-			array_merge(
-				array(
-					'iframe' => array(
-						'src'   => true,
-						'style' => true,
-						'id'    => true,
-						'class' => true,
-					),
-				),
-				wp_kses_allowed_html( 'post' )
-			)
-		);
-	}
+        // Cache the settings schema.
+        $this->schema = $schema;
+
+        return $this->add_additional_fields_schema( $this->schema );
+
+    }
+
+    /**
+     * Validate a text value for a text based setting.
+     *
+     * @since 2.0.0
+     * @param string $value Value.
+     * @param array  $setting Setting.
+     * @return string
+     */
+    public function validate_setting_text_field( $value ) {
+        $value = is_null( $value ) ? '' : $value;
+        return wp_kses_post( trim( stripslashes( $value ) ) );
+    }
+
+    /**
+     * Validate select based settings.
+     *
+     * @since 2.0.0
+     * @param string $value Value.
+     * @param array  $setting Setting.
+     * @return string|WP_Error
+     */
+    public function validate_setting_select_field( $value, $setting ) {
+        if ( array_key_exists( $value, $setting['options'] ) ) {
+            return $value;
+        } else {
+            return new WP_Error( 'rest_setting_value_invalid', __( 'An invalid setting value was passed.', 'invoicing' ), array( 'status' => 400 ) );
+        }
+    }
+
+    /**
+     * Validate multiselect based settings.
+     *
+     * @since 2.0.0
+     * @param array $values Values.
+     * @param array $setting Setting.
+     * @return array|WP_Error
+     */
+    public function validate_setting_multiselect_field( $values, $setting ) {
+        if ( empty( $values ) ) {
+            return array();
+        }
+
+        if ( ! is_array( $values ) ) {
+            return new WP_Error( 'rest_setting_value_invalid', __( 'An invalid setting value was passed.', 'invoicing' ), array( 'status' => 400 ) );
+        }
+
+        $final_values = array();
+        foreach ( $values as $value ) {
+            if ( array_key_exists( $value, $setting['options'] ) ) {
+                $final_values[] = $value;
+            }
+        }
+
+        return $final_values;
+    }
+
+    /**
+     * Validate radio based settings.
+     *
+     * @since 2.0.0
+     * @param string $value Value.
+     * @param array  $setting Setting.
+     * @return string|WP_Error
+     */
+    public function validate_setting_radio_field( $value, $setting ) {
+        return $this->validate_setting_select_field( $value, $setting );
+    }
+
+    /**
+     * Validate checkbox based settings.
+     *
+     * @since 2.0.0
+     * @param string $value Value.
+     * @return int
+     */
+    public function validate_setting_checkbox_field( $value ) {
+        return (int) ! empty( $value );
+    }
+
+    /**
+     * Validate textarea based settings.
+     *
+     * @since 2.0.0
+     * @param string $value Value.
+     * @return string
+     */
+    public function validate_setting_textarea_field( $value ) {
+        $value = is_null( $value ) ? '' : $value;
+        return wp_kses(
+            trim( stripslashes( $value ) ),
+            array_merge(
+                array(
+                    'iframe' => array(
+                        'src'   => true,
+                        'style' => true,
+                        'id'    => true,
+                        'class' => true,
+                    ),
+                ),
+                wp_kses_allowed_html( 'post' )
+            )
+        );
+    }
 
 }

includes/libraries/class-emogrifier.php

Indentation +779 added lines, -779 removed lines

@@ -9,346 +9,346 @@ 
  * @author Roman Ožana <ozana@omdesign.cz>
  */
 class Emogrifier {
-	/**
-	 * @var string
-	 */
-	const ENCODING = 'UTF-8';
-
-	/**
-	 * @var integer
-	 */
-	const CACHE_KEY_CSS = 0;
-
-	/**
-	 * @var integer
-	 */
-	const CACHE_KEY_SELECTOR = 1;
-
-	/**
-	 * @var integer
-	 */
-	const CACHE_KEY_XPATH = 2;
-
-	/**
-	 * @var integer
-	 */
-	const CACHE_KEY_CSS_DECLARATION_BLOCK = 3;
-
-	/**
-	 * for calculating nth-of-type and nth-child selectors.
-	 *
-	 * @var integer
-	 */
-	const INDEX = 0;
-
-	/**
-	 * for calculating nth-of-type and nth-child selectors.
-	 *
-	 * @var integer
-	 */
-	const MULTIPLIER = 1;
-
-	/**
-	 * @var string
-	 */
-	const ID_ATTRIBUTE_MATCHER = '/(\\w+)?\\#([\\w\\-]+)/';
-
-	/**
-	 * @var string
-	 */
-	const CLASS_ATTRIBUTE_MATCHER = '/(\\w+|[\\*\\]])?((\\.[\\w\\-]+)+)/';
-
-	/**
-	 * @var string
-	 */
-	private $html = '';
-
-	/**
-	 * @var string
-	 */
-	private $css = '';
-
-	/**
-	 * @var array<string>
-	 */
-	private $unprocessableHtmlTags = array('wbr');
-
-	/**
-	 * @var array<array>
-	 */
-	private $caches = array(
-		self::CACHE_KEY_CSS => array(),
-		self::CACHE_KEY_SELECTOR => array(),
-		self::CACHE_KEY_XPATH => array(),
-		self::CACHE_KEY_CSS_DECLARATION_BLOCK => array(),
-	);
-
-	/**
-	 * the visited nodes with the XPath paths as array keys.
-	 *
-	 * @var array<\DOMNode>
-	 */
-	private $visitedNodes = array();
-
-	/**
-	 * the styles to apply to the nodes with the XPath paths as array keys for the outer array and the attribute names/values.
-	 * as key/value pairs for the inner array.
-	 *
-	 * @var array<array><string>
-	 */
-	private $styleAttributesForNodes = array();
-
-	/**
-	 * This attribute applies to the case where you want to preserve your original text encoding.
-	 *
-	 * By default, emogrifier translates your text into HTML entities for two reasons:
-	 *
-	 * 1. Because of client incompatibilities, it is better practice to send out HTML entities rather than unicode over email.
-	 *
-	 * 2. It translates any illegal XML characters that DOMDocument cannot work with.
-	 *
-	 * If you would like to preserve your original encoding, set this attribute to TRUE.
-	 *
-	 * @var boolean
-	 */
-	public $preserveEncoding = false;
-
-	public static $_media = '';
-
-	/**
-	 * The constructor.
-	 *
-	 * @param string $html the HTML to emogrify, must be UTF-8-encoded
-	 * @param string $css the CSS to merge, must be UTF-8-encoded
-	 */
-	public function __construct($html = '', $css = '') {
-		$this->setHtml($html);
-		$this->setCss($css);
-	}
-
-	/**
-	 * The destructor.
-	 */
-	public function __destruct() {
-		$this->purgeVisitedNodes();
-	}
-
-	/**
-	 * Sets the HTML to emogrify.
-	 *
-	 * @param string $html the HTML to emogrify, must be UTF-8-encoded
-	 */
-	public function setHtml($html = '') {
-		$this->html = $html;
-	}
-
-	/**
-	 * Sets the CSS to merge with the HTML.
-	 *
-	 * @param string $css the CSS to merge, must be UTF-8-encoded
-	 */
-	public function setCss($css = '') {
-		$this->css = $css;
-	}
-
-	/**
-	 * Clears all caches.
-	 */
-	private function clearAllCaches() {
-		$this->clearCache(self::CACHE_KEY_CSS);
-		$this->clearCache(self::CACHE_KEY_SELECTOR);
-		$this->clearCache(self::CACHE_KEY_XPATH);
-		$this->clearCache(self::CACHE_KEY_CSS_DECLARATION_BLOCK);
-	}
-
-	/**
-	 * Clears a single cache by key.
-	 *
-	 * @param integer $key the cache key, must be CACHE_KEY_CSS, CACHE_KEY_SELECTOR, CACHE_KEY_XPATH or CACHE_KEY_CSS_DECLARATION_BLOCK
-	 *
-	 * @throws InvalidArgumentException
-	 */
-	private function clearCache($key) {
-		$allowedCacheKeys = array(self::CACHE_KEY_CSS, self::CACHE_KEY_SELECTOR, self::CACHE_KEY_XPATH, self::CACHE_KEY_CSS_DECLARATION_BLOCK);
-		if (!in_array($key, $allowedCacheKeys, true)) {
-			throw new InvalidArgumentException('Invalid cache key: ' . $key, 1391822035);
-		}
-
-		$this->caches[$key] = array();
-	}
-
-	/**
-	 * Purges the visited nodes.
-	 */
-	private function purgeVisitedNodes() {
-		$this->visitedNodes = array();
-		$this->styleAttributesForNodes = array();
-	}
-
-	/**
-	 * Marks a tag for removal.
-	 *
-	 * There are some HTML tags that DOMDocument cannot process, and it will throw an error if it encounters them.
-	 * In particular, DOMDocument will complain if you try to use HTML5 tags in an XHTML document.
-	 *
-	 * Note: The tags will not be removed if they have any content.
-	 *
-	 * @param string $tagName the tag name, e.g., "p"
-	 */
-	public function addUnprocessableHtmlTag($tagName) {
-		$this->unprocessableHtmlTags[] = $tagName;
-	}
-
-	/**
-	 * Drops a tag from the removal list.
-	 *
-	 * @param string $tagName the tag name, e.g., "p"
-	 */
-	public function removeUnprocessableHtmlTag($tagName) {
-		$key = array_search($tagName, $this->unprocessableHtmlTags, true);
-		if ($key !== false) {
-			unset($this->unprocessableHtmlTags[$key]);
-		}
-	}
-
-	/**
-	 * Applies the CSS you submit to the HTML you submit.
-	 *
-	 * This method places the CSS inline.
-	 *
-	 * @return string
-	 *
-	 * @throws BadMethodCallException
-	 */
-	public function emogrify() {
-		if ($this->html === '') {
-			throw new BadMethodCallException('Please set some HTML first before calling emogrify.', 1390393096);
-		}
-
-		$xmlDocument = $this->createXmlDocument();
-		$xpath = new DOMXPath($xmlDocument);
-		$this->clearAllCaches();
-
-		// before be begin processing the CSS file, parse the document and normalize all existing CSS attributes (changes 'DISPLAY: none' to 'display: none');
-		// we wouldn't have to do this if DOMXPath supported XPath 2.0.
-		// also store a reference of nodes with existing inline styles so we don't overwrite them
-		$this->purgeVisitedNodes();
-
-		$nodesWithStyleAttributes = $xpath->query('//*[@style]');
-		if ($nodesWithStyleAttributes !== false) {
-			/** @var $nodeWithStyleAttribute DOMNode */
-			foreach ($nodesWithStyleAttributes as $node) {
-				$normalizedOriginalStyle = preg_replace_callback( '/[A-z\\-]+(?=\\:)/S', array( $this, 'strtolower' ), $node->getAttribute('style') );
-
-				// in order to not overwrite existing style attributes in the HTML, we have to save the original HTML styles
-				$nodePath = $node->getNodePath();
-				if (!isset($this->styleAttributesForNodes[$nodePath])) {
-					$this->styleAttributesForNodes[$nodePath] = $this->parseCssDeclarationBlock($normalizedOriginalStyle);
-					$this->visitedNodes[$nodePath] = $node;
-				}
-
-				$node->setAttribute('style', $normalizedOriginalStyle);
-			}
-		}
-
-		// grab any existing style blocks from the html and append them to the existing CSS
-		// (these blocks should be appended so as to have precedence over conflicting styles in the existing CSS)
-		$allCss = $this->css;
-
-		$allCss .= $this->getCssFromAllStyleNodes($xpath);
-
-		$cssParts = $this->splitCssAndMediaQuery($allCss);
-		self::$_media = ''; // reset
-
-		$cssKey = md5($cssParts['css']);
-		if (!isset($this->caches[self::CACHE_KEY_CSS][$cssKey])) {
-			// process the CSS file for selectors and definitions
-			preg_match_all('/(?:^|[\\s^{}]*)([^{]+){([^}]*)}/mis', $cssParts['css'], $matches, PREG_SET_ORDER);
-
-			$allSelectors = array();
-			foreach ($matches as $key => $selectorString) {
-				// if there is a blank definition, skip
-				if (!strlen(trim($selectorString[2]))) {
-					continue;
-				}
-
-				// else split by commas and duplicate attributes so we can sort by selector precedence
-				$selectors = explode(',', $selectorString[1]);
-				foreach ($selectors as $selector) {
-					// don't process pseudo-elements and behavioral (dynamic) pseudo-classes; ONLY allow structural pseudo-classes
-					if (strpos($selector, ':') !== false && !preg_match('/:\\S+\\-(child|type)\\(/i', $selector)) {
-						continue;
-					}
-
-					$allSelectors[] = array('selector' => trim($selector),
-											 'attributes' => trim($selectorString[2]),
-											 // keep track of where it appears in the file, since order is important
-											 'line' => $key,
-					);
-				}
-			}
-
-			// now sort the selectors by precedence
-			usort($allSelectors, array($this,'sortBySelectorPrecedence'));
-
-			$this->caches[self::CACHE_KEY_CSS][$cssKey] = $allSelectors;
-		}
-
-		foreach ($this->caches[self::CACHE_KEY_CSS][$cssKey] as $value) {
-			// query the body for the xpath selector
-			$nodesMatchingCssSelectors = $xpath->query($this->translateCssToXpath($value['selector']));
-
-			/** @var $node \DOMNode */
-			foreach ($nodesMatchingCssSelectors as $node) {
-				// if it has a style attribute, get it, process it, and append (overwrite) new stuff
-				if ($node->hasAttribute('style')) {
-					// break it up into an associative array
-					$oldStyleDeclarations = $this->parseCssDeclarationBlock($node->getAttribute('style'));
-				} else {
-					$oldStyleDeclarations = array();
-				}
-				$newStyleDeclarations = $this->parseCssDeclarationBlock($value['attributes']);
-				$node->setAttribute('style', $this->generateStyleStringFromDeclarationsArrays($oldStyleDeclarations, $newStyleDeclarations));
-			}
-		}
-
-		// now iterate through the nodes that contained inline styles in the original HTML
-		foreach ($this->styleAttributesForNodes as $nodePath => $styleAttributesForNode) {
-			$node = $this->visitedNodes[$nodePath];
-			$currentStyleAttributes = $this->parseCssDeclarationBlock($node->getAttribute('style'));
-			$node->setAttribute('style', $this->generateStyleStringFromDeclarationsArrays($currentStyleAttributes, $styleAttributesForNode));
-		}
-
-		// This removes styles from your email that contain display:none.
-		// We need to look for display:none, but we need to do a case-insensitive search. Since DOMDocument only supports XPath 1.0,
-		// lower-case() isn't available to us. We've thus far only set attributes to lowercase, not attribute values. Consequently, we need
-		// to translate() the letters that would be in 'NONE' ("NOE") to lowercase.
-		$nodesWithStyleDisplayNone = $xpath->query('//*[contains(translate(translate(@style," ",""),"NOE","noe"),"display:none")]');
-		// The checks on parentNode and is_callable below ensure that if we've deleted the parent node,
-		// we don't try to call removeChild on a nonexistent child node
-		if ($nodesWithStyleDisplayNone->length > 0) {
-			/** @var $node \DOMNode */
-			foreach ($nodesWithStyleDisplayNone as $node) {
-				if ($node->parentNode && is_callable(array($node->parentNode,'removeChild'))) {
-					$node->parentNode->removeChild($node);
-				}
-			}
-		}
-
-		$this->copyCssWithMediaToStyleNode($cssParts, $xmlDocument);
-
-		if ($this->preserveEncoding) {
-			// Deprecated since PHP 8.2
-			if ( version_compare( PHP_VERSION, '8.2', '<' ) && function_exists( 'mb_convert_encoding' ) ) {
-				return mb_convert_encoding( $xmlDocument->saveHTML(), self::ENCODING, 'HTML-ENTITIES' );
-			} else {
-				return mb_encode_numericentity( $xmlDocument->saveHTML(), [0x80, 0x10FFFF, 0, ~0], self::ENCODING );
-				//return htmlspecialchars_decode( utf8_encode( html_entity_decode( $xmlDocument->saveHTML(), ENT_COMPAT, self::ENCODING ) ) );
-			}
-		} else {
-			return $xmlDocument->saveHTML();
-		}
-	}
+    /**
+     * @var string
+     */
+    const ENCODING = 'UTF-8';
+
+    /**
+     * @var integer
+     */
+    const CACHE_KEY_CSS = 0;
+
+    /**
+     * @var integer
+     */
+    const CACHE_KEY_SELECTOR = 1;
+
+    /**
+     * @var integer
+     */
+    const CACHE_KEY_XPATH = 2;
+
+    /**
+     * @var integer
+     */
+    const CACHE_KEY_CSS_DECLARATION_BLOCK = 3;
+
+    /**
+     * for calculating nth-of-type and nth-child selectors.
+     *
+     * @var integer
+     */
+    const INDEX = 0;
+
+    /**
+     * for calculating nth-of-type and nth-child selectors.
+     *
+     * @var integer
+     */
+    const MULTIPLIER = 1;
+
+    /**
+     * @var string
+     */
+    const ID_ATTRIBUTE_MATCHER = '/(\\w+)?\\#([\\w\\-]+)/';
+
+    /**
+     * @var string
+     */
+    const CLASS_ATTRIBUTE_MATCHER = '/(\\w+|[\\*\\]])?((\\.[\\w\\-]+)+)/';
+
+    /**
+     * @var string
+     */
+    private $html = '';
+
+    /**
+     * @var string
+     */
+    private $css = '';
+
+    /**
+     * @var array<string>
+     */
+    private $unprocessableHtmlTags = array('wbr');
+
+    /**
+     * @var array<array>
+     */
+    private $caches = array(
+        self::CACHE_KEY_CSS => array(),
+        self::CACHE_KEY_SELECTOR => array(),
+        self::CACHE_KEY_XPATH => array(),
+        self::CACHE_KEY_CSS_DECLARATION_BLOCK => array(),
+    );
+
+    /**
+     * the visited nodes with the XPath paths as array keys.
+     *
+     * @var array<\DOMNode>
+     */
+    private $visitedNodes = array();
+
+    /**
+     * the styles to apply to the nodes with the XPath paths as array keys for the outer array and the attribute names/values.
+     * as key/value pairs for the inner array.
+     *
+     * @var array<array><string>
+     */
+    private $styleAttributesForNodes = array();
+
+    /**
+     * This attribute applies to the case where you want to preserve your original text encoding.
+     *
+     * By default, emogrifier translates your text into HTML entities for two reasons:
+     *
+     * 1. Because of client incompatibilities, it is better practice to send out HTML entities rather than unicode over email.
+     *
+     * 2. It translates any illegal XML characters that DOMDocument cannot work with.
+     *
+     * If you would like to preserve your original encoding, set this attribute to TRUE.
+     *
+     * @var boolean
+     */
+    public $preserveEncoding = false;
+
+    public static $_media = '';
+
+    /**
+     * The constructor.
+     *
+     * @param string $html the HTML to emogrify, must be UTF-8-encoded
+     * @param string $css the CSS to merge, must be UTF-8-encoded
+     */
+    public function __construct($html = '', $css = '') {
+        $this->setHtml($html);
+        $this->setCss($css);
+    }
+
+    /**
+     * The destructor.
+     */
+    public function __destruct() {
+        $this->purgeVisitedNodes();
+    }
+
+    /**
+     * Sets the HTML to emogrify.
+     *
+     * @param string $html the HTML to emogrify, must be UTF-8-encoded
+     */
+    public function setHtml($html = '') {
+        $this->html = $html;
+    }
+
+    /**
+     * Sets the CSS to merge with the HTML.
+     *
+     * @param string $css the CSS to merge, must be UTF-8-encoded
+     */
+    public function setCss($css = '') {
+        $this->css = $css;
+    }
+
+    /**
+     * Clears all caches.
+     */
+    private function clearAllCaches() {
+        $this->clearCache(self::CACHE_KEY_CSS);
+        $this->clearCache(self::CACHE_KEY_SELECTOR);
+        $this->clearCache(self::CACHE_KEY_XPATH);
+        $this->clearCache(self::CACHE_KEY_CSS_DECLARATION_BLOCK);
+    }
+
+    /**
+     * Clears a single cache by key.
+     *
+     * @param integer $key the cache key, must be CACHE_KEY_CSS, CACHE_KEY_SELECTOR, CACHE_KEY_XPATH or CACHE_KEY_CSS_DECLARATION_BLOCK
+     *
+     * @throws InvalidArgumentException
+     */
+    private function clearCache($key) {
+        $allowedCacheKeys = array(self::CACHE_KEY_CSS, self::CACHE_KEY_SELECTOR, self::CACHE_KEY_XPATH, self::CACHE_KEY_CSS_DECLARATION_BLOCK);
+        if (!in_array($key, $allowedCacheKeys, true)) {
+            throw new InvalidArgumentException('Invalid cache key: ' . $key, 1391822035);
+        }
+
+        $this->caches[$key] = array();
+    }
+
+    /**
+     * Purges the visited nodes.
+     */
+    private function purgeVisitedNodes() {
+        $this->visitedNodes = array();
+        $this->styleAttributesForNodes = array();
+    }
+
+    /**
+     * Marks a tag for removal.
+     *
+     * There are some HTML tags that DOMDocument cannot process, and it will throw an error if it encounters them.
+     * In particular, DOMDocument will complain if you try to use HTML5 tags in an XHTML document.
+     *
+     * Note: The tags will not be removed if they have any content.
+     *
+     * @param string $tagName the tag name, e.g., "p"
+     */
+    public function addUnprocessableHtmlTag($tagName) {
+        $this->unprocessableHtmlTags[] = $tagName;
+    }
+
+    /**
+     * Drops a tag from the removal list.
+     *
+     * @param string $tagName the tag name, e.g., "p"
+     */
+    public function removeUnprocessableHtmlTag($tagName) {
+        $key = array_search($tagName, $this->unprocessableHtmlTags, true);
+        if ($key !== false) {
+            unset($this->unprocessableHtmlTags[$key]);
+        }
+    }
+
+    /**
+     * Applies the CSS you submit to the HTML you submit.
+     *
+     * This method places the CSS inline.
+     *
+     * @return string
+     *
+     * @throws BadMethodCallException
+     */
+    public function emogrify() {
+        if ($this->html === '') {
+            throw new BadMethodCallException('Please set some HTML first before calling emogrify.', 1390393096);
+        }
+
+        $xmlDocument = $this->createXmlDocument();
+        $xpath = new DOMXPath($xmlDocument);
+        $this->clearAllCaches();
+
+        // before be begin processing the CSS file, parse the document and normalize all existing CSS attributes (changes 'DISPLAY: none' to 'display: none');
+        // we wouldn't have to do this if DOMXPath supported XPath 2.0.
+        // also store a reference of nodes with existing inline styles so we don't overwrite them
+        $this->purgeVisitedNodes();
+
+        $nodesWithStyleAttributes = $xpath->query('//*[@style]');
+        if ($nodesWithStyleAttributes !== false) {
+            /** @var $nodeWithStyleAttribute DOMNode */
+            foreach ($nodesWithStyleAttributes as $node) {
+                $normalizedOriginalStyle = preg_replace_callback( '/[A-z\\-]+(?=\\:)/S', array( $this, 'strtolower' ), $node->getAttribute('style') );
+
+                // in order to not overwrite existing style attributes in the HTML, we have to save the original HTML styles
+                $nodePath = $node->getNodePath();
+                if (!isset($this->styleAttributesForNodes[$nodePath])) {
+                    $this->styleAttributesForNodes[$nodePath] = $this->parseCssDeclarationBlock($normalizedOriginalStyle);
+                    $this->visitedNodes[$nodePath] = $node;
+                }
+
+                $node->setAttribute('style', $normalizedOriginalStyle);
+            }
+        }
+
+        // grab any existing style blocks from the html and append them to the existing CSS
+        // (these blocks should be appended so as to have precedence over conflicting styles in the existing CSS)
+        $allCss = $this->css;
+
+        $allCss .= $this->getCssFromAllStyleNodes($xpath);
+
+        $cssParts = $this->splitCssAndMediaQuery($allCss);
+        self::$_media = ''; // reset
+
+        $cssKey = md5($cssParts['css']);
+        if (!isset($this->caches[self::CACHE_KEY_CSS][$cssKey])) {
+            // process the CSS file for selectors and definitions
+            preg_match_all('/(?:^|[\\s^{}]*)([^{]+){([^}]*)}/mis', $cssParts['css'], $matches, PREG_SET_ORDER);
+
+            $allSelectors = array();
+            foreach ($matches as $key => $selectorString) {
+                // if there is a blank definition, skip
+                if (!strlen(trim($selectorString[2]))) {
+                    continue;
+                }
+
+                // else split by commas and duplicate attributes so we can sort by selector precedence
+                $selectors = explode(',', $selectorString[1]);
+                foreach ($selectors as $selector) {
+                    // don't process pseudo-elements and behavioral (dynamic) pseudo-classes; ONLY allow structural pseudo-classes
+                    if (strpos($selector, ':') !== false && !preg_match('/:\\S+\\-(child|type)\\(/i', $selector)) {
+                        continue;
+                    }
+
+                    $allSelectors[] = array('selector' => trim($selector),
+                                                'attributes' => trim($selectorString[2]),
+                                                // keep track of where it appears in the file, since order is important
+                                                'line' => $key,
+                    );
+                }
+            }
+
+            // now sort the selectors by precedence
+            usort($allSelectors, array($this,'sortBySelectorPrecedence'));
+
+            $this->caches[self::CACHE_KEY_CSS][$cssKey] = $allSelectors;
+        }
+
+        foreach ($this->caches[self::CACHE_KEY_CSS][$cssKey] as $value) {
+            // query the body for the xpath selector
+            $nodesMatchingCssSelectors = $xpath->query($this->translateCssToXpath($value['selector']));
+
+            /** @var $node \DOMNode */
+            foreach ($nodesMatchingCssSelectors as $node) {
+                // if it has a style attribute, get it, process it, and append (overwrite) new stuff
+                if ($node->hasAttribute('style')) {
+                    // break it up into an associative array
+                    $oldStyleDeclarations = $this->parseCssDeclarationBlock($node->getAttribute('style'));
+                } else {
+                    $oldStyleDeclarations = array();
+                }
+                $newStyleDeclarations = $this->parseCssDeclarationBlock($value['attributes']);
+                $node->setAttribute('style', $this->generateStyleStringFromDeclarationsArrays($oldStyleDeclarations, $newStyleDeclarations));
+            }
+        }
+
+        // now iterate through the nodes that contained inline styles in the original HTML
+        foreach ($this->styleAttributesForNodes as $nodePath => $styleAttributesForNode) {
+            $node = $this->visitedNodes[$nodePath];
+            $currentStyleAttributes = $this->parseCssDeclarationBlock($node->getAttribute('style'));
+            $node->setAttribute('style', $this->generateStyleStringFromDeclarationsArrays($currentStyleAttributes, $styleAttributesForNode));
+        }
+
+        // This removes styles from your email that contain display:none.
+        // We need to look for display:none, but we need to do a case-insensitive search. Since DOMDocument only supports XPath 1.0,
+        // lower-case() isn't available to us. We've thus far only set attributes to lowercase, not attribute values. Consequently, we need
+        // to translate() the letters that would be in 'NONE' ("NOE") to lowercase.
+        $nodesWithStyleDisplayNone = $xpath->query('//*[contains(translate(translate(@style," ",""),"NOE","noe"),"display:none")]');
+        // The checks on parentNode and is_callable below ensure that if we've deleted the parent node,
+        // we don't try to call removeChild on a nonexistent child node
+        if ($nodesWithStyleDisplayNone->length > 0) {
+            /** @var $node \DOMNode */
+            foreach ($nodesWithStyleDisplayNone as $node) {
+                if ($node->parentNode && is_callable(array($node->parentNode,'removeChild'))) {
+                    $node->parentNode->removeChild($node);
+                }
+            }
+        }
+
+        $this->copyCssWithMediaToStyleNode($cssParts, $xmlDocument);
+
+        if ($this->preserveEncoding) {
+            // Deprecated since PHP 8.2
+            if ( version_compare( PHP_VERSION, '8.2', '<' ) && function_exists( 'mb_convert_encoding' ) ) {
+                return mb_convert_encoding( $xmlDocument->saveHTML(), self::ENCODING, 'HTML-ENTITIES' );
+            } else {
+                return mb_encode_numericentity( $xmlDocument->saveHTML(), [0x80, 0x10FFFF, 0, ~0], self::ENCODING );
+                //return htmlspecialchars_decode( utf8_encode( html_entity_decode( $xmlDocument->saveHTML(), ENT_COMPAT, self::ENCODING ) ) );
+            }
+        } else {
+            return $xmlDocument->saveHTML();
+        }
+    }
 
     /**
      * String to lower.
@@ -358,143 +358,143 @@ 
      * @param array $m
      * @return string
      */
-	public function strtolower(array $m) {
-		return strtolower($m[0]);
-	}
-
-
-	/**
-	 * This method merges old or existing name/value array with new name/value array.
-	 * and then generates a string of the combined style suitable for placing inline.
-	 * This becomes the single point for CSS string generation allowing for consistent.
-	 * CSS output no matter where the CSS originally came from.
-	 * @param array $oldStyles
-	 * @param array $newStyles
-	 * @return string
-	 */
-	private function generateStyleStringFromDeclarationsArrays(array $oldStyles, array $newStyles) {
-		$combinedStyles = array_merge($oldStyles, $newStyles);
-		$style = '';
-		foreach ($combinedStyles as $attributeName => $attributeValue) {
-			$style .= (strtolower(trim($attributeName)) . ': ' . trim($attributeValue) . '; ');
-		}
-		return trim($style);
-	}
-
-
-	/**
-	 * Copies the media part from CSS array parts to $xmlDocument.
-	 *
-	 * @param array $cssParts
-	 * @param DOMDocument $xmlDocument
-	 */
-	public function copyCssWithMediaToStyleNode(array $cssParts, DOMDocument $xmlDocument) {
-		if (isset($cssParts['media']) && $cssParts['media'] !== '') {
-			$this->addStyleElementToDocument($xmlDocument, $cssParts['media']);
-		}
-	}
-
-	/**
-	 * Returns CSS content.
-	 *
-	 * @param DOMXPath $xpath
-	 * @return string
-	 */
-	private function getCssFromAllStyleNodes(DOMXPath $xpath) {
-		$styleNodes = $xpath->query('//style');
-
-		if ($styleNodes === false) {
-			return '';
-		}
-
-		$css = '';
-		/** @var $styleNode DOMNode */
-		foreach ($styleNodes as $styleNode) {
-			$css .= "\n\n" . $styleNode->nodeValue;
-			$styleNode->parentNode->removeChild($styleNode);
-		}
-
-		return $css;
-	}
-
-	/**
-	 * Adds a style element with $css to $document.
-	 *
-	 * @param DOMDocument $document
-	 * @param string $css
-	 */
-	private function addStyleElementToDocument(DOMDocument $document, $css) {
-		$styleElement = $document->createElement('style', $css);
-		$styleAttribute = $document->createAttribute('type');
-		$styleAttribute->value = 'text/css';
-		$styleElement->appendChild($styleAttribute);
-
-		$head = $this->getOrCreateHeadElement($document);
-		$head->appendChild($styleElement);
-	}
-
-	/**
-	 * Returns the existing or creates a new head element in $document.
-	 *
-	 * @param DOMDocument $document
-	 * @return DOMNode the head element
-	 */
-	private function getOrCreateHeadElement(DOMDocument $document) {
-		$head = $document->getElementsByTagName('head')->item(0);
-
-		if ($head === null) {
-			$head = $document->createElement('head');
-			$html = $document->getElementsByTagName('html')->item(0);
-			$html->insertBefore($head, $document->getElementsByTagName('body')->item(0));
-		}
-
-		return $head;
-	}
-
-	/**
-	 * Splits input CSS code to an array where:
-	 *
-	 * - key "css" will be contains clean CSS code.
-	 * - key "media" will be contains all valuable media queries.
-	 *
-	 * Example:
-	 *
-	 * The CSS code.
-	 *
-	 *   "@import "file.css"; h1 { color:red; } @media { h1 {}} @media tv { h1 {}}"
-	 *
-	 * will be parsed into the following array:
-	 *
-	 *   "css" => "h1 { color:red; }"
-	 *   "media" => "@media { h1 {}}"
-	 *
-	 * @param string $css
-	 * @return array
-	 */
-	private function splitCssAndMediaQuery($css) {
-		$css = preg_replace_callback( '#@media\\s+(?:only\\s)?(?:[\\s{\(]|screen|all)\\s?[^{]+{.*}\\s*}\\s*#misU', array( $this, '_media_concat' ), $css );
-
-		// filter the CSS
-		$search = array(
-			// get rid of css comment code
-			'/\\/\\*.*\\*\\//sU',
-			// strip out any import directives
-			'/^\\s*@import\\s[^;]+;/misU',
-			// strip remains media enclosures
-			'/^\\s*@media\\s[^{]+{(.*)}\\s*}\\s/misU',
-		);
-
-		$replace = array(
-			'',
-			'',
-			'',
-		);
-
-		// clean CSS before output
-		$css = preg_replace($search, $replace, $css);
-
-		return array('css' => $css, 'media' => self::$_media);
-	}
+    public function strtolower(array $m) {
+        return strtolower($m[0]);
+    }
+
+
+    /**
+     * This method merges old or existing name/value array with new name/value array.
+     * and then generates a string of the combined style suitable for placing inline.
+     * This becomes the single point for CSS string generation allowing for consistent.
+     * CSS output no matter where the CSS originally came from.
+     * @param array $oldStyles
+     * @param array $newStyles
+     * @return string
+     */
+    private function generateStyleStringFromDeclarationsArrays(array $oldStyles, array $newStyles) {
+        $combinedStyles = array_merge($oldStyles, $newStyles);
+        $style = '';
+        foreach ($combinedStyles as $attributeName => $attributeValue) {
+            $style .= (strtolower(trim($attributeName)) . ': ' . trim($attributeValue) . '; ');
+        }
+        return trim($style);
+    }
+
+
+    /**
+     * Copies the media part from CSS array parts to $xmlDocument.
+     *
+     * @param array $cssParts
+     * @param DOMDocument $xmlDocument
+     */
+    public function copyCssWithMediaToStyleNode(array $cssParts, DOMDocument $xmlDocument) {
+        if (isset($cssParts['media']) && $cssParts['media'] !== '') {
+            $this->addStyleElementToDocument($xmlDocument, $cssParts['media']);
+        }
+    }
+
+    /**
+     * Returns CSS content.
+     *
+     * @param DOMXPath $xpath
+     * @return string
+     */
+    private function getCssFromAllStyleNodes(DOMXPath $xpath) {
+        $styleNodes = $xpath->query('//style');
+
+        if ($styleNodes === false) {
+            return '';
+        }
+
+        $css = '';
+        /** @var $styleNode DOMNode */
+        foreach ($styleNodes as $styleNode) {
+            $css .= "\n\n" . $styleNode->nodeValue;
+            $styleNode->parentNode->removeChild($styleNode);
+        }
+
+        return $css;
+    }
+
+    /**
+     * Adds a style element with $css to $document.
+     *
+     * @param DOMDocument $document
+     * @param string $css
+     */
+    private function addStyleElementToDocument(DOMDocument $document, $css) {
+        $styleElement = $document->createElement('style', $css);
+        $styleAttribute = $document->createAttribute('type');
+        $styleAttribute->value = 'text/css';
+        $styleElement->appendChild($styleAttribute);
+
+        $head = $this->getOrCreateHeadElement($document);
+        $head->appendChild($styleElement);
+    }
+
+    /**
+     * Returns the existing or creates a new head element in $document.
+     *
+     * @param DOMDocument $document
+     * @return DOMNode the head element
+     */
+    private function getOrCreateHeadElement(DOMDocument $document) {
+        $head = $document->getElementsByTagName('head')->item(0);
+
+        if ($head === null) {
+            $head = $document->createElement('head');
+            $html = $document->getElementsByTagName('html')->item(0);
+            $html->insertBefore($head, $document->getElementsByTagName('body')->item(0));
+        }
+
+        return $head;
+    }
+
+    /**
+     * Splits input CSS code to an array where:
+     *
+     * - key "css" will be contains clean CSS code.
+     * - key "media" will be contains all valuable media queries.
+     *
+     * Example:
+     *
+     * The CSS code.
+     *
+     *   "@import "file.css"; h1 { color:red; } @media { h1 {}} @media tv { h1 {}}"
+     *
+     * will be parsed into the following array:
+     *
+     *   "css" => "h1 { color:red; }"
+     *   "media" => "@media { h1 {}}"
+     *
+     * @param string $css
+     * @return array
+     */
+    private function splitCssAndMediaQuery($css) {
+        $css = preg_replace_callback( '#@media\\s+(?:only\\s)?(?:[\\s{\(]|screen|all)\\s?[^{]+{.*}\\s*}\\s*#misU', array( $this, '_media_concat' ), $css );
+
+        // filter the CSS
+        $search = array(
+            // get rid of css comment code
+            '/\\/\\*.*\\*\\//sU',
+            // strip out any import directives
+            '/^\\s*@import\\s[^;]+;/misU',
+            // strip remains media enclosures
+            '/^\\s*@media\\s[^{]+{(.*)}\\s*}\\s/misU',
+        );
+
+        $replace = array(
+            '',
+            '',
+            '',
+        );
+
+        // clean CSS before output
+        $css = preg_replace($search, $replace, $css);
+
+        return array('css' => $css, 'media' => self::$_media);
+    }
 
     /**
      * Media concat.
@@ -503,306 +503,306 @@ 
      *
      * @param array $matches Matches result array.
      */
-	private function _media_concat( $matches ) {
-		self::$_media .= $matches[0];
-	}
-
-	/**
-	 * Creates a DOMDocument instance with the current HTML.
-	 *
-	 * @return DOMDocument
-	 */
-	private function createXmlDocument() {
-		$xmlDocument = new DOMDocument;
-		$xmlDocument->encoding = self::ENCODING;
-		$xmlDocument->strictErrorChecking = false;
-		$xmlDocument->formatOutput = true;
-		$libXmlState = libxml_use_internal_errors(true);
-		// phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
-		/** @scrutinizer ignore-unhandled */ @$xmlDocument->loadHTML($this->getUnifiedHtml());
-		libxml_clear_errors();
-		libxml_use_internal_errors($libXmlState);
-		$xmlDocument->normalizeDocument();
-
-		return $xmlDocument;
-	}
-
-	/**
-	 * Returns the HTML with the non-ASCII characters converts into HTML entities and the unprocessable HTML tags removed.
-	 *
-	 * @return string the unified HTML
-	 *
-	 * @throws BadMethodCallException
-	 */
-	private function getUnifiedHtml() {
-		if (!empty($this->unprocessableHtmlTags)) {
-			$unprocessableHtmlTags = implode('|', $this->unprocessableHtmlTags);
-			$bodyWithoutUnprocessableTags = preg_replace('/<\\/?(' . $unprocessableHtmlTags . ')[^>]*>/i', '', $this->html);
-		} else {
-			$bodyWithoutUnprocessableTags = $this->html;
-		}
-
-		// Deprecated since PHP 8.2
-		if ( version_compare( PHP_VERSION, '8.2', '<' ) && function_exists( 'mb_convert_encoding' ) ) {
-			return mb_convert_encoding( $bodyWithoutUnprocessableTags, 'HTML-ENTITIES', self::ENCODING );
-		} else {
-			return mb_encode_numericentity( $bodyWithoutUnprocessableTags, [0x80, 0x10FFFF, 0, ~0], self::ENCODING );
-			//return htmlspecialchars_decode( utf8_decode( htmlentities( $bodyWithoutUnprocessableTags, ENT_COMPAT, self::ENCODING, false ) ) );
-		}
-	}
-
-	/**
-	 * @param array $a
-	 * @param array $b
-	 *
-	 * @return integer
-	 */
-	private function sortBySelectorPrecedence(array $a, array $b) {
-		$precedenceA = $this->getCssSelectorPrecedence($a['selector']);
-		$precedenceB = $this->getCssSelectorPrecedence($b['selector']);
-
-		// We want these sorted in ascending order so selectors with lesser precedence get processed first and
-		// selectors with greater precedence get sorted last.
-		// The parenthesis around the -1 are necessary to avoid a PHP_CodeSniffer warning about missing spaces around
-		// arithmetic operators.
-		// @see http://forge.typo3.org/issues/55605
-		$precedenceForEquals = ($a['line'] < $b['line'] ? (-1) : 1);
-		$precedenceForNotEquals = ($precedenceA < $precedenceB ? (-1) : 1);
-		return ($precedenceA === $precedenceB) ? $precedenceForEquals : $precedenceForNotEquals;
-	}
-
-	/**
-	 * @param string $selector
-	 *
-	 * @return integer
-	 */
-	private function getCssSelectorPrecedence($selector) {
-		$selectorKey = md5($selector);
-		if (!isset($this->caches[self::CACHE_KEY_SELECTOR][$selectorKey])) {
-			$precedence = 0;
-			$value = 100;
-			// ids: worth 100, classes: worth 10, elements: worth 1
-			$search = array('\\#','\\.','');
-
-			foreach ($search as $s) {
-				if (trim($selector == '')) {
-					break;
-				}
-				$number = 0;
-				$selector = preg_replace('/' . $s . '\\w+/', '', $selector, -1, $number);
-				$precedence += ($value * $number);
-				$value /= 10;
-			}
-			$this->caches[self::CACHE_KEY_SELECTOR][$selectorKey] = $precedence;
-		}
-
-		return $this->caches[self::CACHE_KEY_SELECTOR][$selectorKey];
-	}
-
-	/**
-	 * Right now, we support all CSS 1 selectors and most CSS2/3 selectors.
-	 *
-	 * @see http://plasmasturm.org/log/444/
-	 *
-	 * @param string $paramCssSelector
-	 *
-	 * @return string
-	 */
-	private function translateCssToXpath($paramCssSelector) {
-		$cssSelector = ' ' . $paramCssSelector . ' ';
-		$cssSelector = preg_replace_callback( '/\s+\w+\s+/', array( $this, 'strtolower' ), $cssSelector );
-		$cssSelector = trim($cssSelector);
-		$xpathKey = md5($cssSelector);
-		if (!isset($this->caches[self::CACHE_KEY_XPATH][$xpathKey])) {
-			// returns an Xpath selector
-			$search = array(
-				// Matches any element that is a child of parent.
-				'/\\s+>\\s+/',
-				// Matches any element that is an adjacent sibling.
-				'/\\s+\\+\\s+/',
-				// Matches any element that is a descendant of an parent element element.
-				'/\\s+/',
-				// first-child pseudo-selector
-				'/([^\\/]+):first-child/i',
-				// last-child pseudo-selector
-				'/([^\\/]+):last-child/i',
-				// Matches attribute only selector
-				'/^\\[(\\w+)\\]/',
-				// Matches element with attribute
-				'/(\\w)\\[(\\w+)\\]/',
-				// Matches element with EXACT attribute
-				'/(\\w)\\[(\\w+)\\=[\'"]?(\\w+)[\'"]?\\]/',
-			);
-			$replace = array(
-				'/',
-				'/following-sibling::*[1]/self::',
-				'//',
-				'*[1]/self::\\1',
-				'*[last()]/self::\\1',
-				'*[@\\1]',
-				'\\1[@\\2]',
-				'\\1[@\\2="\\3"]',
-			);
-
-			$cssSelector = '//' . preg_replace($search, $replace, $cssSelector);
-
-			$cssSelector = preg_replace_callback(self::ID_ATTRIBUTE_MATCHER, array($this, 'matchIdAttributes'), $cssSelector);
-			$cssSelector = preg_replace_callback(self::CLASS_ATTRIBUTE_MATCHER, array($this, 'matchClassAttributes'), $cssSelector);
-
-			// Advanced selectors are going to require a bit more advanced emogrification.
-			// When we required PHP 5.3, we could do this with closures.
-			$cssSelector = preg_replace_callback(
-				'/([^\\/]+):nth-child\\(\s*(odd|even|[+\-]?\\d|[+\\-]?\\d?n(\\s*[+\\-]\\s*\\d)?)\\s*\\)/i',
-				array($this, 'translateNthChild'), $cssSelector
-			);
-			$cssSelector = preg_replace_callback(
-				'/([^\\/]+):nth-of-type\\(\s*(odd|even|[+\-]?\\d|[+\\-]?\\d?n(\\s*[+\\-]\\s*\\d)?)\\s*\\)/i',
-				array($this, 'translateNthOfType'), $cssSelector
-			);
-
-			$this->caches[self::CACHE_KEY_SELECTOR][$xpathKey] = $cssSelector;
-		}
-		return $this->caches[self::CACHE_KEY_SELECTOR][$xpathKey];
-	}
-
-	/**
-	 * @param array $match
-	 *
-	 * @return string
-	 */
-	private function matchIdAttributes(array $match) {
-		return (strlen($match[1]) ? $match[1] : '*') . '[@id="' . $match[2] . '"]';
-	}
-
-	/**
-	 * @param array $match
-	 *
-	 * @return string
-	 */
-	private function matchClassAttributes(array $match) {
-		return (strlen($match[1]) ? $match[1] : '*') . '[contains(concat(" ",@class," "),concat(" ","' .
-			implode(
-				'"," "))][contains(concat(" ",@class," "),concat(" ","',
-				explode('.', substr($match[2], 1))
-			) . '"," "))]';
-	}
-
-	/**
-	 * @param array $match
-	 *
-	 * @return string
-	 */
-	private function translateNthChild(array $match) {
-		$result = $this->parseNth($match);
-
-		if (isset($result[self::MULTIPLIER])) {
-			if ($result[self::MULTIPLIER] < 0) {
-				$result[self::MULTIPLIER] = abs($result[self::MULTIPLIER]);
-				return sprintf('*[(last() - position()) mod %u = %u]/self::%s', $result[self::MULTIPLIER], $result[self::INDEX], $match[1]);
-			} else {
-				return sprintf('*[position() mod %u = %u]/self::%s', $result[self::MULTIPLIER], $result[self::INDEX], $match[1]);
-			}
-		} else {
-			return sprintf('*[%u]/self::%s', $result[self::INDEX], $match[1]);
-		}
-	}
-
-	/**
-	 * @param array $match
-	 *
-	 * @return string
-	 */
-	private function translateNthOfType(array $match) {
-		$result = $this->parseNth($match);
-
-		if (isset($result[self::MULTIPLIER])) {
-			if ($result[self::MULTIPLIER] < 0) {
-				$result[self::MULTIPLIER] = abs($result[self::MULTIPLIER]);
-				return sprintf('%s[(last() - position()) mod %u = %u]', $match[1], $result[self::MULTIPLIER], $result[self::INDEX]);
-			} else {
-				return sprintf('%s[position() mod %u = %u]', $match[1], $result[self::MULTIPLIER], $result[self::INDEX]);
-			}
-		} else {
-			return sprintf('%s[%u]', $match[1], $result[self::INDEX]);
-		}
-	}
-
-	/**
-	 * @param array $match
-	 *
-	 * @return array
-	 */
-	private function parseNth(array $match) {
-		if (in_array(strtolower($match[2]), array('even','odd'))) {
-			$index = strtolower($match[2]) == 'even' ? 0 : 1;
-			return array(self::MULTIPLIER => 2, self::INDEX => $index);
-		} elseif (stripos($match[2], 'n') === false) {
-			// if there is a multiplier
-			$index = intval(str_replace(' ', '', $match[2]));
-			return array(self::INDEX => $index);
-		} else {
-			if (isset($match[3])) {
-				$multipleTerm = str_replace($match[3], '', $match[2]);
-				$index = intval(str_replace(' ', '', $match[3]));
-			} else {
-				$multipleTerm = $match[2];
-				$index = 0;
-			}
-
-			$multiplier = str_ireplace('n', '', $multipleTerm);
-
-			if (!strlen($multiplier)) {
-				$multiplier = 1;
-			} elseif ($multiplier == 0) {
-				return array(self::INDEX => $index);
-			} else {
-				$multiplier = intval($multiplier);
-			}
-
-			while ($index < 0) {
-				$index += abs($multiplier);
-			}
-
-			return array(self::MULTIPLIER => $multiplier, self::INDEX => $index);
-		}
-	}
-
-	/**
-	 * Parses a CSS declaration block into property name/value pairs.
-	 *
-	 * Example:
-	 *
-	 * The declaration block.
-	 *
-	 *   "color: #000; font-weight: bold;".
-	 *
-	 * will be parsed into the following array:
-	 *
-	 *   "color" => "#000"
-	 *   "font-weight" => "bold"
-	 *
-	 * @param string $cssDeclarationBlock the CSS declaration block without the curly braces, may be empty
-	 *
-	 * @return array the CSS declarations with the property names as array keys and the property values as array values
-	 */
-	private function parseCssDeclarationBlock($cssDeclarationBlock) {
-		if (isset($this->caches[self::CACHE_KEY_CSS_DECLARATION_BLOCK][$cssDeclarationBlock])) {
-			return $this->caches[self::CACHE_KEY_CSS_DECLARATION_BLOCK][$cssDeclarationBlock];
-		}
-
-		$properties = array();
-		$declarations = explode(';', $cssDeclarationBlock);
-		foreach ($declarations as $declaration) {
-			$matches = array();
-			if (!preg_match('/ *([A-Za-z\\-]+) *: *([^;]+) */', $declaration, $matches)) {
-				continue;
-			}
-			$propertyName = strtolower($matches[1]);
-			$propertyValue = $matches[2];
-			$properties[$propertyName] = $propertyValue;
-		}
-		$this->caches[self::CACHE_KEY_CSS_DECLARATION_BLOCK][$cssDeclarationBlock] = $properties;
-
-		return $properties;
-	}
+    private function _media_concat( $matches ) {
+        self::$_media .= $matches[0];
+    }
+
+    /**
+     * Creates a DOMDocument instance with the current HTML.
+     *
+     * @return DOMDocument
+     */
+    private function createXmlDocument() {
+        $xmlDocument = new DOMDocument;
+        $xmlDocument->encoding = self::ENCODING;
+        $xmlDocument->strictErrorChecking = false;
+        $xmlDocument->formatOutput = true;
+        $libXmlState = libxml_use_internal_errors(true);
+        // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
+        /** @scrutinizer ignore-unhandled */ @$xmlDocument->loadHTML($this->getUnifiedHtml());
+        libxml_clear_errors();
+        libxml_use_internal_errors($libXmlState);
+        $xmlDocument->normalizeDocument();
+
+        return $xmlDocument;
+    }
+
+    /**
+     * Returns the HTML with the non-ASCII characters converts into HTML entities and the unprocessable HTML tags removed.
+     *
+     * @return string the unified HTML
+     *
+     * @throws BadMethodCallException
+     */
+    private function getUnifiedHtml() {
+        if (!empty($this->unprocessableHtmlTags)) {
+            $unprocessableHtmlTags = implode('|', $this->unprocessableHtmlTags);
+            $bodyWithoutUnprocessableTags = preg_replace('/<\\/?(' . $unprocessableHtmlTags . ')[^>]*>/i', '', $this->html);
+        } else {
+            $bodyWithoutUnprocessableTags = $this->html;
+        }
+
+        // Deprecated since PHP 8.2
+        if ( version_compare( PHP_VERSION, '8.2', '<' ) && function_exists( 'mb_convert_encoding' ) ) {
+            return mb_convert_encoding( $bodyWithoutUnprocessableTags, 'HTML-ENTITIES', self::ENCODING );
+        } else {
+            return mb_encode_numericentity( $bodyWithoutUnprocessableTags, [0x80, 0x10FFFF, 0, ~0], self::ENCODING );
+            //return htmlspecialchars_decode( utf8_decode( htmlentities( $bodyWithoutUnprocessableTags, ENT_COMPAT, self::ENCODING, false ) ) );
+        }
+    }
+
+    /**
+     * @param array $a
+     * @param array $b
+     *
+     * @return integer
+     */
+    private function sortBySelectorPrecedence(array $a, array $b) {
+        $precedenceA = $this->getCssSelectorPrecedence($a['selector']);
+        $precedenceB = $this->getCssSelectorPrecedence($b['selector']);
+
+        // We want these sorted in ascending order so selectors with lesser precedence get processed first and
+        // selectors with greater precedence get sorted last.
+        // The parenthesis around the -1 are necessary to avoid a PHP_CodeSniffer warning about missing spaces around
+        // arithmetic operators.
+        // @see http://forge.typo3.org/issues/55605
+        $precedenceForEquals = ($a['line'] < $b['line'] ? (-1) : 1);
+        $precedenceForNotEquals = ($precedenceA < $precedenceB ? (-1) : 1);
+        return ($precedenceA === $precedenceB) ? $precedenceForEquals : $precedenceForNotEquals;
+    }
+
+    /**
+     * @param string $selector
+     *
+     * @return integer
+     */
+    private function getCssSelectorPrecedence($selector) {
+        $selectorKey = md5($selector);
+        if (!isset($this->caches[self::CACHE_KEY_SELECTOR][$selectorKey])) {
+            $precedence = 0;
+            $value = 100;
+            // ids: worth 100, classes: worth 10, elements: worth 1
+            $search = array('\\#','\\.','');
+
+            foreach ($search as $s) {
+                if (trim($selector == '')) {
+                    break;
+                }
+                $number = 0;
+                $selector = preg_replace('/' . $s . '\\w+/', '', $selector, -1, $number);
+                $precedence += ($value * $number);
+                $value /= 10;
+            }
+            $this->caches[self::CACHE_KEY_SELECTOR][$selectorKey] = $precedence;
+        }
+
+        return $this->caches[self::CACHE_KEY_SELECTOR][$selectorKey];
+    }
+
+    /**
+     * Right now, we support all CSS 1 selectors and most CSS2/3 selectors.
+     *
+     * @see http://plasmasturm.org/log/444/
+     *
+     * @param string $paramCssSelector
+     *
+     * @return string
+     */
+    private function translateCssToXpath($paramCssSelector) {
+        $cssSelector = ' ' . $paramCssSelector . ' ';
+        $cssSelector = preg_replace_callback( '/\s+\w+\s+/', array( $this, 'strtolower' ), $cssSelector );
+        $cssSelector = trim($cssSelector);
+        $xpathKey = md5($cssSelector);
+        if (!isset($this->caches[self::CACHE_KEY_XPATH][$xpathKey])) {
+            // returns an Xpath selector
+            $search = array(
+                // Matches any element that is a child of parent.
+                '/\\s+>\\s+/',
+                // Matches any element that is an adjacent sibling.
+                '/\\s+\\+\\s+/',
+                // Matches any element that is a descendant of an parent element element.
+                '/\\s+/',
+                // first-child pseudo-selector
+                '/([^\\/]+):first-child/i',
+                // last-child pseudo-selector
+                '/([^\\/]+):last-child/i',
+                // Matches attribute only selector
+                '/^\\[(\\w+)\\]/',
+                // Matches element with attribute
+                '/(\\w)\\[(\\w+)\\]/',
+                // Matches element with EXACT attribute
+                '/(\\w)\\[(\\w+)\\=[\'"]?(\\w+)[\'"]?\\]/',
+            );
+            $replace = array(
+                '/',
+                '/following-sibling::*[1]/self::',
+                '//',
+                '*[1]/self::\\1',
+                '*[last()]/self::\\1',
+                '*[@\\1]',
+                '\\1[@\\2]',
+                '\\1[@\\2="\\3"]',
+            );
+
+            $cssSelector = '//' . preg_replace($search, $replace, $cssSelector);
+
+            $cssSelector = preg_replace_callback(self::ID_ATTRIBUTE_MATCHER, array($this, 'matchIdAttributes'), $cssSelector);
+            $cssSelector = preg_replace_callback(self::CLASS_ATTRIBUTE_MATCHER, array($this, 'matchClassAttributes'), $cssSelector);
+
+            // Advanced selectors are going to require a bit more advanced emogrification.
+            // When we required PHP 5.3, we could do this with closures.
+            $cssSelector = preg_replace_callback(
+                '/([^\\/]+):nth-child\\(\s*(odd|even|[+\-]?\\d|[+\\-]?\\d?n(\\s*[+\\-]\\s*\\d)?)\\s*\\)/i',
+                array($this, 'translateNthChild'), $cssSelector
+            );
+            $cssSelector = preg_replace_callback(
+                '/([^\\/]+):nth-of-type\\(\s*(odd|even|[+\-]?\\d|[+\\-]?\\d?n(\\s*[+\\-]\\s*\\d)?)\\s*\\)/i',
+                array($this, 'translateNthOfType'), $cssSelector
+            );
+
+            $this->caches[self::CACHE_KEY_SELECTOR][$xpathKey] = $cssSelector;
+        }
+        return $this->caches[self::CACHE_KEY_SELECTOR][$xpathKey];
+    }
+
+    /**
+     * @param array $match
+     *
+     * @return string
+     */
+    private function matchIdAttributes(array $match) {
+        return (strlen($match[1]) ? $match[1] : '*') . '[@id="' . $match[2] . '"]';
+    }
+
+    /**
+     * @param array $match
+     *
+     * @return string
+     */
+    private function matchClassAttributes(array $match) {
+        return (strlen($match[1]) ? $match[1] : '*') . '[contains(concat(" ",@class," "),concat(" ","' .
+            implode(
+                '"," "))][contains(concat(" ",@class," "),concat(" ","',
+                explode('.', substr($match[2], 1))
+            ) . '"," "))]';
+    }
+
+    /**
+     * @param array $match
+     *
+     * @return string
+     */
+    private function translateNthChild(array $match) {
+        $result = $this->parseNth($match);
+
+        if (isset($result[self::MULTIPLIER])) {
+            if ($result[self::MULTIPLIER] < 0) {
+                $result[self::MULTIPLIER] = abs($result[self::MULTIPLIER]);
+                return sprintf('*[(last() - position()) mod %u = %u]/self::%s', $result[self::MULTIPLIER], $result[self::INDEX], $match[1]);
+            } else {
+                return sprintf('*[position() mod %u = %u]/self::%s', $result[self::MULTIPLIER], $result[self::INDEX], $match[1]);
+            }
+        } else {
+            return sprintf('*[%u]/self::%s', $result[self::INDEX], $match[1]);
+        }
+    }
+
+    /**
+     * @param array $match
+     *
+     * @return string
+     */
+    private function translateNthOfType(array $match) {
+        $result = $this->parseNth($match);
+
+        if (isset($result[self::MULTIPLIER])) {
+            if ($result[self::MULTIPLIER] < 0) {
+                $result[self::MULTIPLIER] = abs($result[self::MULTIPLIER]);
+                return sprintf('%s[(last() - position()) mod %u = %u]', $match[1], $result[self::MULTIPLIER], $result[self::INDEX]);
+            } else {
+                return sprintf('%s[position() mod %u = %u]', $match[1], $result[self::MULTIPLIER], $result[self::INDEX]);
+            }
+        } else {
+            return sprintf('%s[%u]', $match[1], $result[self::INDEX]);
+        }
+    }
+
+    /**
+     * @param array $match
+     *
+     * @return array
+     */
+    private function parseNth(array $match) {
+        if (in_array(strtolower($match[2]), array('even','odd'))) {
+            $index = strtolower($match[2]) == 'even' ? 0 : 1;
+            return array(self::MULTIPLIER => 2, self::INDEX => $index);
+        } elseif (stripos($match[2], 'n') === false) {
+            // if there is a multiplier
+            $index = intval(str_replace(' ', '', $match[2]));
+            return array(self::INDEX => $index);
+        } else {
+            if (isset($match[3])) {
+                $multipleTerm = str_replace($match[3], '', $match[2]);
+                $index = intval(str_replace(' ', '', $match[3]));
+            } else {
+                $multipleTerm = $match[2];
+                $index = 0;
+            }
+
+            $multiplier = str_ireplace('n', '', $multipleTerm);
+
+            if (!strlen($multiplier)) {
+                $multiplier = 1;
+            } elseif ($multiplier == 0) {
+                return array(self::INDEX => $index);
+            } else {
+                $multiplier = intval($multiplier);
+            }
+
+            while ($index < 0) {
+                $index += abs($multiplier);
+            }
+
+            return array(self::MULTIPLIER => $multiplier, self::INDEX => $index);
+        }
+    }
+
+    /**
+     * Parses a CSS declaration block into property name/value pairs.
+     *
+     * Example:
+     *
+     * The declaration block.
+     *
+     *   "color: #000; font-weight: bold;".
+     *
+     * will be parsed into the following array:
+     *
+     *   "color" => "#000"
+     *   "font-weight" => "bold"
+     *
+     * @param string $cssDeclarationBlock the CSS declaration block without the curly braces, may be empty
+     *
+     * @return array the CSS declarations with the property names as array keys and the property values as array values
+     */
+    private function parseCssDeclarationBlock($cssDeclarationBlock) {
+        if (isset($this->caches[self::CACHE_KEY_CSS_DECLARATION_BLOCK][$cssDeclarationBlock])) {
+            return $this->caches[self::CACHE_KEY_CSS_DECLARATION_BLOCK][$cssDeclarationBlock];
+        }
+
+        $properties = array();
+        $declarations = explode(';', $cssDeclarationBlock);
+        foreach ($declarations as $declaration) {
+            $matches = array();
+            if (!preg_match('/ *([A-Za-z\\-]+) *: *([^;]+) */', $declaration, $matches)) {
+                continue;
+            }
+            $propertyName = strtolower($matches[1]);
+            $propertyValue = $matches[2];
+            $properties[$propertyName] = $propertyValue;
+        }
+        $this->caches[self::CACHE_KEY_CSS_DECLARATION_BLOCK][$cssDeclarationBlock] = $properties;
+
+        return $properties;
+    }
 }

includes/wpinv-payment-functions.php

Indentation +286 added lines, -286 removed lines

@@ -1,196 +1,196 @@ 
 <?php
 function wpinv_is_subscription_payment( $invoice = '' ) {
-	if ( empty( $invoice ) ) {
-		return false;
-	}
+    if ( empty( $invoice ) ) {
+        return false;
+    }
 
-	if ( ! is_object( $invoice ) && is_scalar( $invoice ) ) {
-		$invoice = wpinv_get_invoice( $invoice );
-	}
+    if ( ! is_object( $invoice ) && is_scalar( $invoice ) ) {
+        $invoice = wpinv_get_invoice( $invoice );
+    }
 
-	if ( empty( $invoice ) ) {
-		return false;
-	}
+    if ( empty( $invoice ) ) {
+        return false;
+    }
 
-	if ( $invoice->is_renewal() ) {
-		return true;
-	}
+    if ( $invoice->is_renewal() ) {
+        return true;
+    }
 
-	return false;
+    return false;
 }
 
 function wpinv_payment_link_transaction_id( $invoice = '' ) {
-	if ( empty( $invoice ) ) {
-		return false;
-	}
+    if ( empty( $invoice ) ) {
+        return false;
+    }
 
-	if ( ! is_object( $invoice ) && is_scalar( $invoice ) ) {
-		$invoice = wpinv_get_invoice( $invoice );
-	}
+    if ( ! is_object( $invoice ) && is_scalar( $invoice ) ) {
+        $invoice = wpinv_get_invoice( $invoice );
+    }
 
-	if ( empty( $invoice ) ) {
-		return false;
-	}
+    if ( empty( $invoice ) ) {
+        return false;
+    }
 
-	return apply_filters( 'wpinv_payment_details_transaction_id-' . $invoice->gateway, $invoice->get_transaction_id(), $invoice->ID, $invoice );
+    return apply_filters( 'wpinv_payment_details_transaction_id-' . $invoice->gateway, $invoice->get_transaction_id(), $invoice->ID, $invoice );
 }
 
 function wpinv_subscription_initial_payment_desc( $amount, $period, $interval, $trial_period = '', $trial_interval = 0 ) {
-	$interval   = (int)$interval > 0 ? (int)$interval : 1;
-
-	if ( $trial_interval > 0 && ! empty( $trial_period ) ) {
-		$amount = __( 'Free', 'invoicing' );
-		$interval = $trial_interval;
-		$period = $trial_period;
-	}
-
-	$description = '';
-	switch ( $period ) {
-		case 'D':
-		case 'day':
-			$description = wp_sprintf( _n( '%s for the first day.', '%1$s for the first %2$d days.', $interval, 'invoicing' ), $amount, $interval );
-			break;
-		case 'W':
-		case 'week':
-			$description = wp_sprintf( _n( '%s for the first week.', '%1$s for the first %2$d weeks.', $interval, 'invoicing' ), $amount, $interval );
-			break;
-		case 'M':
-		case 'month':
-			$description = wp_sprintf( _n( '%s for the first month.', '%1$s for the first %2$d months.', $interval, 'invoicing' ), $amount, $interval );
-			break;
-		case 'Y':
-		case 'year':
-			$description = wp_sprintf( _n( '%s for the first year.', '%1$s for the first %2$d years.', $interval, 'invoicing' ), $amount, $interval );
-			break;
-	}
-
-	return apply_filters( 'wpinv_subscription_initial_payment_desc', $description, $amount, $period, $interval, $trial_period, $trial_interval );
+    $interval   = (int)$interval > 0 ? (int)$interval : 1;
+
+    if ( $trial_interval > 0 && ! empty( $trial_period ) ) {
+        $amount = __( 'Free', 'invoicing' );
+        $interval = $trial_interval;
+        $period = $trial_period;
+    }
+
+    $description = '';
+    switch ( $period ) {
+        case 'D':
+        case 'day':
+            $description = wp_sprintf( _n( '%s for the first day.', '%1$s for the first %2$d days.', $interval, 'invoicing' ), $amount, $interval );
+            break;
+        case 'W':
+        case 'week':
+            $description = wp_sprintf( _n( '%s for the first week.', '%1$s for the first %2$d weeks.', $interval, 'invoicing' ), $amount, $interval );
+            break;
+        case 'M':
+        case 'month':
+            $description = wp_sprintf( _n( '%s for the first month.', '%1$s for the first %2$d months.', $interval, 'invoicing' ), $amount, $interval );
+            break;
+        case 'Y':
+        case 'year':
+            $description = wp_sprintf( _n( '%s for the first year.', '%1$s for the first %2$d years.', $interval, 'invoicing' ), $amount, $interval );
+            break;
+    }
+
+    return apply_filters( 'wpinv_subscription_initial_payment_desc', $description, $amount, $period, $interval, $trial_period, $trial_interval );
 }
 
 function wpinv_subscription_recurring_payment_desc( $amount, $period, $interval, $bill_times = 0, $trial_period = '', $trial_interval = 0 ) {
-	$interval   = (int)$interval > 0 ? (int)$interval : 1;
-	$bill_times = (int)$bill_times > 0 ? (int)$bill_times : 0;
-
-	$description = '';
-	switch ( $period ) {
-		case 'D':
-		case 'day':
-			if ( (int)$bill_times > 0 ) {
-				if ( $interval > 1 ) {
-					if ( $bill_times > 1 ) {
-						$description = wp_sprintf( __( '%1$s for each %2$d days, for %3$d installments.', 'invoicing' ), $amount, $interval, $bill_times );
-					} else {
-						$description = wp_sprintf( __( '%1$s for %2$d days.', 'invoicing' ), $amount, $interval );
-					}
-				} else {
-					$description = wp_sprintf( _n( '%s for one day.', '%1$s for each day, for %2$d installments.', $bill_times, 'invoicing' ), $amount, $bill_times );
-				}
-			} else {
-				$description = wp_sprintf( _n( '%s for each day.', '%1$s for each %2$d days.', $interval, 'invoicing' ), $amount, $interval );
-			}
-			break;
-		case 'W':
-		case 'week':
-			if ( (int)$bill_times > 0 ) {
-				if ( $interval > 1 ) {
-					if ( $bill_times > 1 ) {
-						$description = wp_sprintf( __( '%1$s for each %2$d weeks, for %3$d installments.', 'invoicing' ), $amount, $interval, $bill_times );
-					} else {
-						$description = wp_sprintf( __( '%1$s for %2$d weeks.', 'invoicing' ), $amount, $interval );
-					}
-				} else {
-					$description = wp_sprintf( _n( '%s for one week.', '%1$s for each week, for %2$d installments.', $bill_times, 'invoicing' ), $amount, $bill_times );
-				}
-			} else {
-				$description = wp_sprintf( _n( '%s for each week.', '%1$s for each %2$d weeks.', $interval, 'invoicing' ), $amount, $interval );
-			}
-			break;
-		case 'M':
-		case 'month':
-			if ( (int)$bill_times > 0 ) {
-				if ( $interval > 1 ) {
-					if ( $bill_times > 1 ) {
-						$description = wp_sprintf( __( '%1$s for each %2$d months, for %3$d installments.', 'invoicing' ), $amount, $interval, $bill_times );
-					} else {
-						$description = wp_sprintf( __( '%1$s for %2$d months.', 'invoicing' ), $amount, $interval );
-					}
-				} else {
-					$description = wp_sprintf( _n( '%s for one month.', '%1$s for each month, for %2$d installments.', $bill_times, 'invoicing' ), $amount, $bill_times );
-				}
-			} else {
-				$description = wp_sprintf( _n( '%s for each month.', '%1$s for each %2$d months.', $interval, 'invoicing' ), $amount, $interval );
-			}
-			break;
-		case 'Y':
-		case 'year':
-			if ( (int)$bill_times > 0 ) {
-				if ( $interval > 1 ) {
-					if ( $bill_times > 1 ) {
-						$description = wp_sprintf( __( '%1$s for each %2$d years, for %3$d installments.', 'invoicing' ), $amount, $interval, $bill_times );
-					} else {
-						$description = wp_sprintf( __( '%1$s for %2$d years.', 'invoicing' ), $amount, $interval );
-					}
-				} else {
-					$description = wp_sprintf( _n( '%s for one year.', '%1$s for each year, for %2$d installments.', $bill_times, 'invoicing' ), $amount, $bill_times );
-				}
-			} else {
-				$description = wp_sprintf( _n( '%s for each year.', '%1$s for each %2$d years.', $interval, 'invoicing' ), $amount, $interval );
-			}
-			break;
-	}
-
-	return apply_filters( 'wpinv_subscription_recurring_payment_desc', $description, $amount, $period, $interval, $bill_times, $trial_period, $trial_interval );
+    $interval   = (int)$interval > 0 ? (int)$interval : 1;
+    $bill_times = (int)$bill_times > 0 ? (int)$bill_times : 0;
+
+    $description = '';
+    switch ( $period ) {
+        case 'D':
+        case 'day':
+            if ( (int)$bill_times > 0 ) {
+                if ( $interval > 1 ) {
+                    if ( $bill_times > 1 ) {
+                        $description = wp_sprintf( __( '%1$s for each %2$d days, for %3$d installments.', 'invoicing' ), $amount, $interval, $bill_times );
+                    } else {
+                        $description = wp_sprintf( __( '%1$s for %2$d days.', 'invoicing' ), $amount, $interval );
+                    }
+                } else {
+                    $description = wp_sprintf( _n( '%s for one day.', '%1$s for each day, for %2$d installments.', $bill_times, 'invoicing' ), $amount, $bill_times );
+                }
+            } else {
+                $description = wp_sprintf( _n( '%s for each day.', '%1$s for each %2$d days.', $interval, 'invoicing' ), $amount, $interval );
+            }
+            break;
+        case 'W':
+        case 'week':
+            if ( (int)$bill_times > 0 ) {
+                if ( $interval > 1 ) {
+                    if ( $bill_times > 1 ) {
+                        $description = wp_sprintf( __( '%1$s for each %2$d weeks, for %3$d installments.', 'invoicing' ), $amount, $interval, $bill_times );
+                    } else {
+                        $description = wp_sprintf( __( '%1$s for %2$d weeks.', 'invoicing' ), $amount, $interval );
+                    }
+                } else {
+                    $description = wp_sprintf( _n( '%s for one week.', '%1$s for each week, for %2$d installments.', $bill_times, 'invoicing' ), $amount, $bill_times );
+                }
+            } else {
+                $description = wp_sprintf( _n( '%s for each week.', '%1$s for each %2$d weeks.', $interval, 'invoicing' ), $amount, $interval );
+            }
+            break;
+        case 'M':
+        case 'month':
+            if ( (int)$bill_times > 0 ) {
+                if ( $interval > 1 ) {
+                    if ( $bill_times > 1 ) {
+                        $description = wp_sprintf( __( '%1$s for each %2$d months, for %3$d installments.', 'invoicing' ), $amount, $interval, $bill_times );
+                    } else {
+                        $description = wp_sprintf( __( '%1$s for %2$d months.', 'invoicing' ), $amount, $interval );
+                    }
+                } else {
+                    $description = wp_sprintf( _n( '%s for one month.', '%1$s for each month, for %2$d installments.', $bill_times, 'invoicing' ), $amount, $bill_times );
+                }
+            } else {
+                $description = wp_sprintf( _n( '%s for each month.', '%1$s for each %2$d months.', $interval, 'invoicing' ), $amount, $interval );
+            }
+            break;
+        case 'Y':
+        case 'year':
+            if ( (int)$bill_times > 0 ) {
+                if ( $interval > 1 ) {
+                    if ( $bill_times > 1 ) {
+                        $description = wp_sprintf( __( '%1$s for each %2$d years, for %3$d installments.', 'invoicing' ), $amount, $interval, $bill_times );
+                    } else {
+                        $description = wp_sprintf( __( '%1$s for %2$d years.', 'invoicing' ), $amount, $interval );
+                    }
+                } else {
+                    $description = wp_sprintf( _n( '%s for one year.', '%1$s for each year, for %2$d installments.', $bill_times, 'invoicing' ), $amount, $bill_times );
+                }
+            } else {
+                $description = wp_sprintf( _n( '%s for each year.', '%1$s for each %2$d years.', $interval, 'invoicing' ), $amount, $interval );
+            }
+            break;
+    }
+
+    return apply_filters( 'wpinv_subscription_recurring_payment_desc', $description, $amount, $period, $interval, $bill_times, $trial_period, $trial_interval );
 }
 
 function wpinv_subscription_payment_desc( $invoice ) {
-	if ( empty( $invoice ) ) {
-		return null;
-	}
-
-	$description = '';
-	if ( $invoice->is_parent() && $item = $invoice->get_recurring( true ) ) {
-		if ( $item->has_free_trial() ) {
-			$trial_period = $item->get_trial_period();
-			$trial_interval = $item->get_trial_interval();
-		} else {
-			$trial_period = '';
-			$trial_interval = 0;
-		}
-
-		$description = wpinv_get_billing_cycle( $invoice->get_total(), $invoice->get_recurring_details( 'total' ), $item->get_recurring_period(), $item->get_recurring_interval(), $item->get_recurring_limit(), $trial_period, $trial_interval, $invoice->get_currency() );
-	}
-
-	return apply_filters( 'wpinv_subscription_payment_desc', $description, $invoice );
+    if ( empty( $invoice ) ) {
+        return null;
+    }
+
+    $description = '';
+    if ( $invoice->is_parent() && $item = $invoice->get_recurring( true ) ) {
+        if ( $item->has_free_trial() ) {
+            $trial_period = $item->get_trial_period();
+            $trial_interval = $item->get_trial_interval();
+        } else {
+            $trial_period = '';
+            $trial_interval = 0;
+        }
+
+        $description = wpinv_get_billing_cycle( $invoice->get_total(), $invoice->get_recurring_details( 'total' ), $item->get_recurring_period(), $item->get_recurring_interval(), $item->get_recurring_limit(), $trial_period, $trial_interval, $invoice->get_currency() );
+    }
+
+    return apply_filters( 'wpinv_subscription_payment_desc', $description, $invoice );
 }
 
 function wpinv_get_billing_cycle( $initial, $recurring, $period, $interval, $bill_times, $trial_period = '', $trial_interval = 0, $currency = '' ) {
-	$initial_total      = wpinv_round_amount( $initial );
-	$recurring_total    = wpinv_round_amount( $recurring );
+    $initial_total      = wpinv_round_amount( $initial );
+    $recurring_total    = wpinv_round_amount( $recurring );
 
-	if ( $trial_interval > 0 && ! empty( $trial_period ) ) {
-		// Free trial
-	} else {
-		if ( $bill_times == 1 ) {
-			$recurring_total = $initial_total;
-		} elseif ( $bill_times > 1 && $initial_total != $recurring_total ) {
-			$bill_times--;
-		}
-	}
+    if ( $trial_interval > 0 && ! empty( $trial_period ) ) {
+        // Free trial
+    } else {
+        if ( $bill_times == 1 ) {
+            $recurring_total = $initial_total;
+        } elseif ( $bill_times > 1 && $initial_total != $recurring_total ) {
+            $bill_times--;
+        }
+    }
 
-	$initial_amount     = wpinv_price( $initial_total, $currency );
-	$recurring_amount   = wpinv_price( $recurring_total, $currency );
+    $initial_amount     = wpinv_price( $initial_total, $currency );
+    $recurring_amount   = wpinv_price( $recurring_total, $currency );
 
-	$recurring          = wpinv_subscription_recurring_payment_desc( $recurring_amount, $period, $interval, $bill_times, $trial_period, $trial_interval );
+    $recurring          = wpinv_subscription_recurring_payment_desc( $recurring_amount, $period, $interval, $bill_times, $trial_period, $trial_interval );
 
-	if ( $initial_total != $recurring_total ) {
-		$initial        = wpinv_subscription_initial_payment_desc( $initial_amount, $period, $interval, $trial_period, $trial_interval );
+    if ( $initial_total != $recurring_total ) {
+        $initial        = wpinv_subscription_initial_payment_desc( $initial_amount, $period, $interval, $trial_period, $trial_interval );
 
-		$description    = wp_sprintf( __( '%1$s Then %2$s', 'invoicing' ), $initial, $recurring );
-	} else {
-		$description    = $recurring;
-	}
+        $description    = wp_sprintf( __( '%1$s Then %2$s', 'invoicing' ), $initial, $recurring );
+    } else {
+        $description    = $recurring;
+    }
 
-	return apply_filters( 'wpinv_get_billing_cycle', $description, $initial, $recurring, $period, $interval, $bill_times, $trial_period, $trial_interval, $currency );
+    return apply_filters( 'wpinv_get_billing_cycle', $description, $initial, $recurring, $period, $interval, $bill_times, $trial_period, $trial_interval, $currency );
 }
 
 /**
@@ -202,25 +202,25 @@ 
  */
 function getpaid_get_card_name( $card_number ) {
 
-	// Known regexes.
-	$regexes = array(
-		'/^4/'                     => __( 'Visa', 'invoicing' ),
-		'/^5[1-5]/'                => __( 'Mastercard', 'invoicing' ),
-		'/^3[47]/'                 => __( 'Amex', 'invoicing' ),
-		'/^3(?:0[0-5]|[68])/'      => __( 'Diners Club', 'invoicing' ),
-		'/^6(?:011|5)/'            => __( 'Discover', 'invoicing' ),
-		'/^(?:2131|1800|35\d{3})/' => __( 'JCB', 'invoicing' ),
-	);
-
-	// Confirm if one matches.
-	foreach ( $regexes as $regex => $card ) {
-		if ( preg_match( $regex, $card_number ) >= 1 ) {
-			return $card;
-		}
-	}
-
-	// None matched.
-	return __( 'Card', 'invoicing' );
+    // Known regexes.
+    $regexes = array(
+        '/^4/'                     => __( 'Visa', 'invoicing' ),
+        '/^5[1-5]/'                => __( 'Mastercard', 'invoicing' ),
+        '/^3[47]/'                 => __( 'Amex', 'invoicing' ),
+        '/^3(?:0[0-5]|[68])/'      => __( 'Diners Club', 'invoicing' ),
+        '/^6(?:011|5)/'            => __( 'Discover', 'invoicing' ),
+        '/^(?:2131|1800|35\d{3})/' => __( 'JCB', 'invoicing' ),
+    );
+
+    // Confirm if one matches.
+    foreach ( $regexes as $regex => $card ) {
+        if ( preg_match( $regex, $card_number ) >= 1 ) {
+            return $card;
+        }
+    }
+
+    // None matched.
+    return __( 'Card', 'invoicing' );
 
 }
 
@@ -230,24 +230,24 @@ 
  * @param WPInv_Invoice|int|null $invoice
  */
 function wpinv_send_back_to_checkout( $invoice = null ) {
-	$response = array( 'success' => false );
-	$invoice  = wpinv_get_invoice( $invoice );
-
-	// Was an invoice created?
-	if ( ! empty( $invoice ) ) {
-		$invoice             = is_scalar( $invoice ) ? new WPInv_Invoice( $invoice ) : $invoice;
-		$response['invoice'] = $invoice->get_id();
-		do_action( 'getpaid_checkout_invoice_exception', $invoice );
-	}
-
-	// Do we have any errors?
-	if ( wpinv_get_errors() ) {
-		$response['data'] = getpaid_get_errors_html( true, false );
-	} else {
-		$response['data'] = __( 'An error occured while processing your payment. Please try again.', 'invoicing' );
-	}
-
-	wp_send_json( $response );
+    $response = array( 'success' => false );
+    $invoice  = wpinv_get_invoice( $invoice );
+
+    // Was an invoice created?
+    if ( ! empty( $invoice ) ) {
+        $invoice             = is_scalar( $invoice ) ? new WPInv_Invoice( $invoice ) : $invoice;
+        $response['invoice'] = $invoice->get_id();
+        do_action( 'getpaid_checkout_invoice_exception', $invoice );
+    }
+
+    // Do we have any errors?
+    if ( wpinv_get_errors() ) {
+        $response['data'] = getpaid_get_errors_html( true, false );
+    } else {
+        $response['data'] = __( 'An error occured while processing your payment. Please try again.', 'invoicing' );
+    }
+
+    wp_send_json( $response );
 }
 
 /**
@@ -256,7 +256,7 @@ 
  * @return string
  */
 function getpaid_get_recaptcha_site_key() {
-	return apply_filters( 'getpaid_recaptcha_site_key', wpinv_get_option( 'recaptcha_site_key', '' ) );
+    return apply_filters( 'getpaid_recaptcha_site_key', wpinv_get_option( 'recaptcha_site_key', '' ) );
 }
 
 /**
@@ -265,7 +265,7 @@ 
  * @return string
  */
 function getpaid_get_recaptcha_secret_key() {
-	return apply_filters( 'getpaid_recaptcha_secret_key', wpinv_get_option( 'recaptcha_secret_key', '' ) );
+    return apply_filters( 'getpaid_recaptcha_secret_key', wpinv_get_option( 'recaptcha_secret_key', '' ) );
 }
 
 /**
@@ -274,7 +274,7 @@ 
  * @return bool
  */
 function getpaid_is_recaptcha_enabled() {
-	return wpinv_get_option( 'enable_recaptcha', false ) && getpaid_get_recaptcha_site_key() && getpaid_get_recaptcha_secret_key();
+    return wpinv_get_option( 'enable_recaptcha', false ) && getpaid_get_recaptcha_site_key() && getpaid_get_recaptcha_secret_key();
 }
 
 /**
@@ -283,27 +283,27 @@ 
  * @return string
  */
 function getpaid_get_recaptcha_version() {
-	return apply_filters( 'getpaid_recaptcha_version', wpinv_get_option( 'recaptcha_version', 'v2' ) );
+    return apply_filters( 'getpaid_recaptcha_version', wpinv_get_option( 'recaptcha_version', 'v2' ) );
 }
 
 function getpaid_recaptcha_api_url() {
-	// Prevent conflicts with Ninja Forms recaptcha.
-	if ( ! empty( $_REQUEST['action'] ) && $_REQUEST['action'] == 'geodir_ninja_forms' ) {
-		$url = '';
-	} else {
-		$url = getpaid_recaptcha_get_api_url();
-	}
-
-	return apply_filters( 'getpaid_recaptcha_api_url', $url );
+    // Prevent conflicts with Ninja Forms recaptcha.
+    if ( ! empty( $_REQUEST['action'] ) && $_REQUEST['action'] == 'geodir_ninja_forms' ) {
+        $url = '';
+    } else {
+        $url = getpaid_recaptcha_get_api_url();
+    }
+
+    return apply_filters( 'getpaid_recaptcha_api_url', $url );
 }
 
 function getpaid_recaptcha_get_api_url() {
-	return add_query_arg(
-		array(
-			'render' => 'v2' === getpaid_get_recaptcha_version() ? 'explicit' : getpaid_get_recaptcha_site_key(),
-		),
-		'https://www.google.com/recaptcha/api.js'
-	);
+    return add_query_arg(
+        array(
+            'render' => 'v2' === getpaid_get_recaptcha_version() ? 'explicit' : getpaid_get_recaptcha_site_key(),
+        ),
+        'https://www.google.com/recaptcha/api.js'
+    );
 }
 
 /**
@@ -312,42 +312,42 @@ 
  * @return array
  */
 function getpaid_get_recaptcha_settings() {
-	$settings = array(
-		'enabled' => getpaid_is_recaptcha_enabled(),
-		'version' => getpaid_get_recaptcha_version(),
-	);
-
-	if ( ! getpaid_is_recaptcha_enabled() ) {
-		return $settings;
-	}
-
-	$settings['sitekey'] = getpaid_get_recaptcha_site_key();
-
-	// Version 2 render params.
-	if ( 'v2' === getpaid_get_recaptcha_version() ) {
-		$settings['render_params'] = array(
-			'sitekey'  => getpaid_get_recaptcha_site_key(),
-			'theme'    => 'light',
-			'size'     => 'normal',
-			'tabindex' => 0,
-		);
-	}
-
-	return apply_filters( 'getpaid_recaptcha_settings', $settings );
+    $settings = array(
+        'enabled' => getpaid_is_recaptcha_enabled(),
+        'version' => getpaid_get_recaptcha_version(),
+    );
+
+    if ( ! getpaid_is_recaptcha_enabled() ) {
+        return $settings;
+    }
+
+    $settings['sitekey'] = getpaid_get_recaptcha_site_key();
+
+    // Version 2 render params.
+    if ( 'v2' === getpaid_get_recaptcha_version() ) {
+        $settings['render_params'] = array(
+            'sitekey'  => getpaid_get_recaptcha_site_key(),
+            'theme'    => 'light',
+            'size'     => 'normal',
+            'tabindex' => 0,
+        );
+    }
+
+    return apply_filters( 'getpaid_recaptcha_settings', $settings );
 }
 
 /**
  * Displays reCAPTCHA before payment button.
  */
 function getpaid_display_recaptcha_before_payment_button() {
-	if ( ! getpaid_is_recaptcha_enabled() || 'v2' !== getpaid_get_recaptcha_version() ) {
-		return;
-	}
-
-	printf(
-		'<div class="getpaid-recaptcha-wrapper"><div class="g-recaptcha mw-100 overflow-hidden my-2" id="getpaid-recaptcha-%s"></div></div>',
-		esc_attr( wp_unique_id() )
-	);
+    if ( ! getpaid_is_recaptcha_enabled() || 'v2' !== getpaid_get_recaptcha_version() ) {
+        return;
+    }
+
+    printf(
+        '<div class="getpaid-recaptcha-wrapper"><div class="g-recaptcha mw-100 overflow-hidden my-2" id="getpaid-recaptcha-%s"></div></div>',
+        esc_attr( wp_unique_id() )
+    );
 }
 add_action( 'getpaid_before_payment_form_pay_button', 'getpaid_display_recaptcha_before_payment_button' );
 
@@ -358,43 +358,43 @@ 
  */
 function getpaid_validate_recaptcha_response( $submission ) {
 
-	// Check if reCAPTCHA is enabled.
-	if ( ! getpaid_is_recaptcha_enabled() ) {
-		return;
-	}
-
-	$token = $submission->get_field( 'g-recaptcha-response' );
-
-	// Abort if no token was provided.
-	if ( empty( $token ) ) {
-		wp_send_json_error( 'v2' === getpaid_get_recaptcha_version() ? __( 'Please confirm that you are not a robot.', 'invoicing' ) : __( "Unable to verify that you're not a robot. Please try again.", 'invoicing' ) );
-	}
-
-	$result = wp_remote_post(
-		'https://www.google.com/recaptcha/api/siteverify',
-		array(
-			'body' => array(
-				'secret'   => getpaid_get_recaptcha_secret_key(),
-				'response' => $token,
-			),
-		)
-	);
-
-	// Site not reachable, give benefit of doubt.
-	if ( is_wp_error( $result ) ) {
-		return;
-	}
-
-	$result = json_decode( wp_remote_retrieve_body( $result ), true );
-
-	if ( empty( $result['success'] ) && ! in_array( 'missing-input-secret', $result['error-codes'], true ) && ! in_array( 'invalid-input-secret', $result['error-codes'], true ) ) {
-		wp_send_json_error( __( "Unable to verify that you're not a robot. Please try again.", 'invoicing' ) );
-	}
-
-	// For v3, check the score.
-	$minimum_score = apply_filters( 'getpaid_recaptcha_minimum_score', 0.4 );
-	if ( 'v3' === getpaid_get_recaptcha_version() && ( empty( $result['score'] ) || $result['score'] < $minimum_score ) ) {
-		wp_send_json_error( __( "Unable to verify that you're not a robot. Please try again.", 'invoicing' ) );
-	}
+    // Check if reCAPTCHA is enabled.
+    if ( ! getpaid_is_recaptcha_enabled() ) {
+        return;
+    }
+
+    $token = $submission->get_field( 'g-recaptcha-response' );
+
+    // Abort if no token was provided.
+    if ( empty( $token ) ) {
+        wp_send_json_error( 'v2' === getpaid_get_recaptcha_version() ? __( 'Please confirm that you are not a robot.', 'invoicing' ) : __( "Unable to verify that you're not a robot. Please try again.", 'invoicing' ) );
+    }
+
+    $result = wp_remote_post(
+        'https://www.google.com/recaptcha/api/siteverify',
+        array(
+            'body' => array(
+                'secret'   => getpaid_get_recaptcha_secret_key(),
+                'response' => $token,
+            ),
+        )
+    );
+
+    // Site not reachable, give benefit of doubt.
+    if ( is_wp_error( $result ) ) {
+        return;
+    }
+
+    $result = json_decode( wp_remote_retrieve_body( $result ), true );
+
+    if ( empty( $result['success'] ) && ! in_array( 'missing-input-secret', $result['error-codes'], true ) && ! in_array( 'invalid-input-secret', $result['error-codes'], true ) ) {
+        wp_send_json_error( __( "Unable to verify that you're not a robot. Please try again.", 'invoicing' ) );
+    }
+
+    // For v3, check the score.
+    $minimum_score = apply_filters( 'getpaid_recaptcha_minimum_score', 0.4 );
+    if ( 'v3' === getpaid_get_recaptcha_version() && ( empty( $result['score'] ) || $result['score'] < $minimum_score ) ) {
+        wp_send_json_error( __( "Unable to verify that you're not a robot. Please try again.", 'invoicing' ) );
+    }
 }
 add_action( 'getpaid_checkout_error_checks', 'getpaid_validate_recaptcha_response' );

includes/class-getpaid-template.php

Indentation +152 added lines, -152 removed lines

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

includes/gateways/class-getpaid-paypal-gateway-ipn-handler.php

Indentation +405 added lines, -405 removed lines

@@ -12,482 +12,482 @@
  */
 class GetPaid_Paypal_Gateway_IPN_Handler {
 
-	/**
-	 * Payment method id.
-	 *
-	 * @var string
-	 */
-	protected $id = 'paypal';
-
-	/**
-	 * Payment method object.
-	 *
-	 * @var GetPaid_Paypal_Gateway
-	 */
-	protected $gateway;
-
-	/**
-	 * Class constructor.
-	 *
-	 * @param GetPaid_Paypal_Gateway $gateway
-	 */
-	public function __construct( $gateway ) {
-		$this->gateway = $gateway;
-		$this->verify_ipn();
-	}
-
-	/**
-	 * Processes ipns and marks payments as complete.
-	 *
-	 * @return void
-	 */
-	public function verify_ipn() {
-
-		wpinv_error_log( 'GetPaid PayPal IPN Handler', false );
-
-		// Validate the IPN.
-		if ( empty( $_POST ) || ! $this->validate_ipn() ) {
-			wp_die( 'PayPal IPN Request Failure', 500 );
-		}
-
-		// Process the IPN.
-		$posted  = wp_unslash( $_POST );
-		$invoice = $this->get_ipn_invoice( $posted );
-
-		// Abort if it was not paid by our gateway.
-		if ( $this->id != $invoice->get_gateway() ) {
-			wpinv_error_log( 'Aborting, Invoice was not paid via PayPal', false );
-			wp_die( 'Invoice not paid via PayPal', 200 );
-		}
-
-		$posted['payment_status'] = isset( $posted['payment_status'] ) ? sanitize_key( strtolower( $posted['payment_status'] ) ) : '';
-		$posted['txn_type']       = sanitize_key( strtolower( $posted['txn_type'] ) );
-
-		wpinv_error_log( 'Payment status:' . $posted['payment_status'], false );
-		wpinv_error_log( 'IPN Type:' . $posted['txn_type'], false );
-
-		if ( method_exists( $this, 'ipn_txn_' . $posted['txn_type'] ) ) {
-			call_user_func( array( $this, 'ipn_txn_' . $posted['txn_type'] ), $invoice, $posted );
-			wpinv_error_log( 'Done processing IPN', false );
-			wp_die( 'Processed', 200 );
-		}
-
-		wpinv_error_log( 'Aborting, Unsupported IPN type:' . $posted['txn_type'], false );
-		wp_die( 'Unsupported IPN type', 200 );
-
-	}
-
-	/**
-	 * Retrieves IPN Invoice.
-	 *
-	 * @param array $posted
-	 * @return WPInv_Invoice
-	 */
-	protected function get_ipn_invoice( $posted ) {
-
-		wpinv_error_log( 'Retrieving PayPal IPN Response Invoice', false );
-
-		if ( ! empty( $posted['custom'] ) ) {
-			$invoice = new WPInv_Invoice( $posted['custom'] );
-
-			if ( $invoice->exists() ) {
-				wpinv_error_log( 'Found invoice #' . $invoice->get_number(), false );
-				return $invoice;
-			}
-		}
-
-		wpinv_error_log( 'Could not retrieve the associated invoice.', false );
-		wp_die( 'Could not retrieve the associated invoice.', 200 );
-	}
-
-	/**
-	 * Check PayPal IPN validity.
-	 */
-	protected function validate_ipn() {
-
-		wpinv_error_log( 'Validating PayPal IPN response', false );
-
-		// Retrieve the associated invoice.
-		$posted  = wp_unslash( $_POST );
-		$invoice = $this->get_ipn_invoice( $posted );
-
-		if ( $this->gateway->is_sandbox( $invoice ) ) {
-			wpinv_error_log( $posted, 'Invoice was processed in sandbox hence logging the posted data', false );
-		}
-
-		// Validate the IPN.
-		$posted['cmd'] = '_notify-validate';
-
-		// Send back post vars to paypal.
-		$params = array(
-			'body'        => $posted,
-			'timeout'     => 60,
-			'httpversion' => '1.1',
-			'compress'    => false,
-			'decompress'  => false,
-			'user-agent'  => 'GetPaid/' . WPINV_VERSION,
-		);
-
-		// Post back to get a response.
-		$response = wp_safe_remote_post( $this->gateway->is_sandbox( $invoice ) ? 'https://www.sandbox.paypal.com/cgi-bin/webscr' : 'https://www.paypal.com/cgi-bin/webscr', $params );
-
-		// Check to see if the request was valid.
-		if ( ! is_wp_error( $response ) && $response['response']['code'] < 300 && strstr( $response['body'], 'VERIFIED' ) ) {
-			$invoice->add_note( 'Received valid response from PayPal IPN: ' . $response['body'], false, false, true );
-			wpinv_error_log( 'Received valid response from PayPal IPN: ' . $response['body'], false );
-			return true;
-		}
-
-		$invoice->add_note( 'IPN message:' . wp_json_encode( $posted ), false, false, true );
-
-		if ( is_wp_error( $response ) ) {
-			$invoice->add_note( 'Received invalid response from PayPal IPN: ' . $response->get_error_message(), false, false, true );
-			wpinv_error_log( $response->get_error_message(), 'Received invalid response from PayPal IPN' );
-			return false;
-		}
-
-		$invoice->add_note( 'Received invalid response from PayPal IPN: ' . $response['body'], false, false, true );
-		wpinv_error_log( $response['body'], 'Received invalid response from PayPal IPN' );
-		return false;
-
-	}
-
-	/**
-	 * Check currency from IPN matches the invoice.
-	 *
-	 * @param WPInv_Invoice $invoice          Invoice object.
-	 * @param string   $currency currency to validate.
-	 */
-	protected function validate_ipn_currency( $invoice, $currency ) {
+    /**
+     * Payment method id.
+     *
+     * @var string
+     */
+    protected $id = 'paypal';
+
+    /**
+     * Payment method object.
+     *
+     * @var GetPaid_Paypal_Gateway
+     */
+    protected $gateway;
+
+    /**
+     * Class constructor.
+     *
+     * @param GetPaid_Paypal_Gateway $gateway
+     */
+    public function __construct( $gateway ) {
+        $this->gateway = $gateway;
+        $this->verify_ipn();
+    }
+
+    /**
+     * Processes ipns and marks payments as complete.
+     *
+     * @return void
+     */
+    public function verify_ipn() {
+
+        wpinv_error_log( 'GetPaid PayPal IPN Handler', false );
+
+        // Validate the IPN.
+        if ( empty( $_POST ) || ! $this->validate_ipn() ) {
+            wp_die( 'PayPal IPN Request Failure', 500 );
+        }
+
+        // Process the IPN.
+        $posted  = wp_unslash( $_POST );
+        $invoice = $this->get_ipn_invoice( $posted );
+
+        // Abort if it was not paid by our gateway.
+        if ( $this->id != $invoice->get_gateway() ) {
+            wpinv_error_log( 'Aborting, Invoice was not paid via PayPal', false );
+            wp_die( 'Invoice not paid via PayPal', 200 );
+        }
+
+        $posted['payment_status'] = isset( $posted['payment_status'] ) ? sanitize_key( strtolower( $posted['payment_status'] ) ) : '';
+        $posted['txn_type']       = sanitize_key( strtolower( $posted['txn_type'] ) );
+
+        wpinv_error_log( 'Payment status:' . $posted['payment_status'], false );
+        wpinv_error_log( 'IPN Type:' . $posted['txn_type'], false );
+
+        if ( method_exists( $this, 'ipn_txn_' . $posted['txn_type'] ) ) {
+            call_user_func( array( $this, 'ipn_txn_' . $posted['txn_type'] ), $invoice, $posted );
+            wpinv_error_log( 'Done processing IPN', false );
+            wp_die( 'Processed', 200 );
+        }
+
+        wpinv_error_log( 'Aborting, Unsupported IPN type:' . $posted['txn_type'], false );
+        wp_die( 'Unsupported IPN type', 200 );
+
+    }
+
+    /**
+     * Retrieves IPN Invoice.
+     *
+     * @param array $posted
+     * @return WPInv_Invoice
+     */
+    protected function get_ipn_invoice( $posted ) {
+
+        wpinv_error_log( 'Retrieving PayPal IPN Response Invoice', false );
+
+        if ( ! empty( $posted['custom'] ) ) {
+            $invoice = new WPInv_Invoice( $posted['custom'] );
+
+            if ( $invoice->exists() ) {
+                wpinv_error_log( 'Found invoice #' . $invoice->get_number(), false );
+                return $invoice;
+            }
+        }
+
+        wpinv_error_log( 'Could not retrieve the associated invoice.', false );
+        wp_die( 'Could not retrieve the associated invoice.', 200 );
+    }
+
+    /**
+     * Check PayPal IPN validity.
+     */
+    protected function validate_ipn() {
+
+        wpinv_error_log( 'Validating PayPal IPN response', false );
+
+        // Retrieve the associated invoice.
+        $posted  = wp_unslash( $_POST );
+        $invoice = $this->get_ipn_invoice( $posted );
+
+        if ( $this->gateway->is_sandbox( $invoice ) ) {
+            wpinv_error_log( $posted, 'Invoice was processed in sandbox hence logging the posted data', false );
+        }
+
+        // Validate the IPN.
+        $posted['cmd'] = '_notify-validate';
+
+        // Send back post vars to paypal.
+        $params = array(
+            'body'        => $posted,
+            'timeout'     => 60,
+            'httpversion' => '1.1',
+            'compress'    => false,
+            'decompress'  => false,
+            'user-agent'  => 'GetPaid/' . WPINV_VERSION,
+        );
+
+        // Post back to get a response.
+        $response = wp_safe_remote_post( $this->gateway->is_sandbox( $invoice ) ? 'https://www.sandbox.paypal.com/cgi-bin/webscr' : 'https://www.paypal.com/cgi-bin/webscr', $params );
+
+        // Check to see if the request was valid.
+        if ( ! is_wp_error( $response ) && $response['response']['code'] < 300 && strstr( $response['body'], 'VERIFIED' ) ) {
+            $invoice->add_note( 'Received valid response from PayPal IPN: ' . $response['body'], false, false, true );
+            wpinv_error_log( 'Received valid response from PayPal IPN: ' . $response['body'], false );
+            return true;
+        }
+
+        $invoice->add_note( 'IPN message:' . wp_json_encode( $posted ), false, false, true );
+
+        if ( is_wp_error( $response ) ) {
+            $invoice->add_note( 'Received invalid response from PayPal IPN: ' . $response->get_error_message(), false, false, true );
+            wpinv_error_log( $response->get_error_message(), 'Received invalid response from PayPal IPN' );
+            return false;
+        }
+
+        $invoice->add_note( 'Received invalid response from PayPal IPN: ' . $response['body'], false, false, true );
+        wpinv_error_log( $response['body'], 'Received invalid response from PayPal IPN' );
+        return false;
+
+    }
+
+    /**
+     * Check currency from IPN matches the invoice.
+     *
+     * @param WPInv_Invoice $invoice          Invoice object.
+     * @param string   $currency currency to validate.
+     */
+    protected function validate_ipn_currency( $invoice, $currency ) {
 
-		if ( strtolower( $invoice->get_currency() ) !== strtolower( $currency ) ) {
-
-			/* translators: %s: currency code. */
-			$invoice->update_status( 'wpi-processing', wp_sprintf( __( 'Validation error: PayPal currencies do not match (code %s).', 'invoicing' ), $currency ) );
-			$invoice->add_note( wp_sprintf( __( 'Validation error: PayPal currencies do not match (code %s).', 'invoicing' ), $currency ), false, false, true );
-
-			wpinv_error_log( "Currencies do not match: {$currency} instead of {$invoice->get_currency()}", 'IPN Error', __FILE__, __LINE__, true );
-		}
-
-		wpinv_error_log( $currency, 'Validated IPN Currency', false );
-	}
+        if ( strtolower( $invoice->get_currency() ) !== strtolower( $currency ) ) {
+
+            /* translators: %s: currency code. */
+            $invoice->update_status( 'wpi-processing', wp_sprintf( __( 'Validation error: PayPal currencies do not match (code %s).', 'invoicing' ), $currency ) );
+            $invoice->add_note( wp_sprintf( __( 'Validation error: PayPal currencies do not match (code %s).', 'invoicing' ), $currency ), false, false, true );
+
+            wpinv_error_log( "Currencies do not match: {$currency} instead of {$invoice->get_currency()}", 'IPN Error', __FILE__, __LINE__, true );
+        }
+
+        wpinv_error_log( $currency, 'Validated IPN Currency', false );
+    }
 
-	/**
-	 * Check payment amount from IPN matches the invoice.
-	 *
-	 * @param WPInv_Invoice $invoice          Invoice object.
-	 * @param float   $amount amount to validate.
-	 */
-	protected function validate_ipn_amount( $invoice, $amount ) {
-		if ( number_format( $invoice->get_total(), 2, '.', '' ) !== number_format( $amount, 2, '.', '' ) ) {
+    /**
+     * Check payment amount from IPN matches the invoice.
+     *
+     * @param WPInv_Invoice $invoice          Invoice object.
+     * @param float   $amount amount to validate.
+     */
+    protected function validate_ipn_amount( $invoice, $amount ) {
+        if ( number_format( $invoice->get_total(), 2, '.', '' ) !== number_format( $amount, 2, '.', '' ) ) {
 
-			/* translators: %s: Amount. */
-			$invoice->update_status( 'wpi-processing', wp_sprintf( __( 'Validation error: PayPal amounts do not match (gross %s).', 'invoicing' ), $amount ) );
-			$invoice->add_note( wp_sprintf( __( 'Validation error: PayPal amounts do not match (gross %s).', 'invoicing' ), $amount ), false, false, true );
+            /* translators: %s: Amount. */
+            $invoice->update_status( 'wpi-processing', wp_sprintf( __( 'Validation error: PayPal amounts do not match (gross %s).', 'invoicing' ), $amount ) );
+            $invoice->add_note( wp_sprintf( __( 'Validation error: PayPal amounts do not match (gross %s).', 'invoicing' ), $amount ), false, false, true );
 
-			wpinv_error_log( "Amounts do not match: {$amount} instead of {$invoice->get_total()}", 'IPN Error', __FILE__, __LINE__, true );
-		}
+            wpinv_error_log( "Amounts do not match: {$amount} instead of {$invoice->get_total()}", 'IPN Error', __FILE__, __LINE__, true );
+        }
 
-		wpinv_error_log( $amount, 'Validated IPN Amount', false );
-	}
+        wpinv_error_log( $amount, 'Validated IPN Amount', false );
+    }
 
-	/**
-	 * Verify receiver email from PayPal.
-	 *
-	 * @param WPInv_Invoice $invoice          Invoice object.
-	 * @param string   $receiver_email Email to validate.
-	 */
-	protected function validate_ipn_receiver_email( $invoice, $receiver_email ) {
-		$paypal_email = $this->gateway->is_sandbox( $invoice ) ? wpinv_get_option( 'paypal_sandbox_email', wpinv_get_option( 'paypal_email', '' ) ) : wpinv_get_option( 'paypal_email', '' );
+    /**
+     * Verify receiver email from PayPal.
+     *
+     * @param WPInv_Invoice $invoice          Invoice object.
+     * @param string   $receiver_email Email to validate.
+     */
+    protected function validate_ipn_receiver_email( $invoice, $receiver_email ) {
+        $paypal_email = $this->gateway->is_sandbox( $invoice ) ? wpinv_get_option( 'paypal_sandbox_email', wpinv_get_option( 'paypal_email', '' ) ) : wpinv_get_option( 'paypal_email', '' );
 
-		if ( $receiver_email && strcasecmp( trim( $receiver_email ), trim( $paypal_email ) ) !== 0 ) {
-			wpinv_record_gateway_error( 'IPN Error', "IPN Response is for another account: {$receiver_email}. Your PayPal email is {$paypal_email}." );
-
-			/* translators: %s: email address . */
-			$invoice->update_status( 'wpi-processing', wp_sprintf( __( 'Validation error: PayPal IPN response from a different email address (%s). Your PayPal email is %s.', 'invoicing' ), $receiver_email, $paypal_email ) );
-			$invoice->add_note( wp_sprintf( __( 'Validation error: PayPal IPN response from a different email address (%s). Your PayPal email is %s.', 'invoicing' ), $receiver_email, $paypal_email ), false, false, true );
+        if ( $receiver_email && strcasecmp( trim( $receiver_email ), trim( $paypal_email ) ) !== 0 ) {
+            wpinv_record_gateway_error( 'IPN Error', "IPN Response is for another account: {$receiver_email}. Your PayPal email is {$paypal_email}." );
+
+            /* translators: %s: email address . */
+            $invoice->update_status( 'wpi-processing', wp_sprintf( __( 'Validation error: PayPal IPN response from a different email address (%s). Your PayPal email is %s.', 'invoicing' ), $receiver_email, $paypal_email ) );
+            $invoice->add_note( wp_sprintf( __( 'Validation error: PayPal IPN response from a different email address (%s). Your PayPal email is %s.', 'invoicing' ), $receiver_email, $paypal_email ), false, false, true );
 
-			return wpinv_error_log( "IPN Response is for another account: {$receiver_email}. Your email PayPal is {$paypal_email}.", 'IPN Error', __FILE__, __LINE__, true );
-		}
+            return wpinv_error_log( "IPN Response is for another account: {$receiver_email}. Your email PayPal is {$paypal_email}.", 'IPN Error', __FILE__, __LINE__, true );
+        }
 
-		wpinv_error_log( 'Validated PayPal Email', false );
-	}
-
-	/**
-	 * Handles one time payments.
-	 *
-	 * @param WPInv_Invoice $invoice  Invoice object.
-	 * @param array    $posted Posted data.
-	 */
-	protected function ipn_txn_web_accept( $invoice, $posted ) {
+        wpinv_error_log( 'Validated PayPal Email', false );
+    }
+
+    /**
+     * Handles one time payments.
+     *
+     * @param WPInv_Invoice $invoice  Invoice object.
+     * @param array    $posted Posted data.
+     */
+    protected function ipn_txn_web_accept( $invoice, $posted ) {
 
-		// Collect payment details
-		$payment_status = strtolower( $posted['payment_status'] );
-		$business_email = isset( $posted['business'] ) && is_email( $posted['business'] ) ? trim( $posted['business'] ) : trim( $posted['receiver_email'] );
+        // Collect payment details
+        $payment_status = strtolower( $posted['payment_status'] );
+        $business_email = isset( $posted['business'] ) && is_email( $posted['business'] ) ? trim( $posted['business'] ) : trim( $posted['receiver_email'] );
 
-		$this->validate_ipn_receiver_email( $invoice, $business_email );
-		$this->validate_ipn_currency( $invoice, $posted['mc_currency'] );
+        $this->validate_ipn_receiver_email( $invoice, $business_email );
+        $this->validate_ipn_currency( $invoice, $posted['mc_currency'] );
 
-		// Update the transaction id.
-		if ( ! empty( $posted['txn_id'] ) ) {
-			$invoice->set_transaction_id( wpinv_clean( $posted['txn_id'] ) );
-			$invoice->save();
-		}
+        // Update the transaction id.
+        if ( ! empty( $posted['txn_id'] ) ) {
+            $invoice->set_transaction_id( wpinv_clean( $posted['txn_id'] ) );
+            $invoice->save();
+        }
 
-		$invoice->add_system_note( __( 'Processing invoice IPN', 'invoicing' ) );
+        $invoice->add_system_note( __( 'Processing invoice IPN', 'invoicing' ) );
 
-		// Process a refund.
-		if ( 'refunded' === $payment_status || 'reversed' === $payment_status ) {
+        // Process a refund.
+        if ( 'refunded' === $payment_status || 'reversed' === $payment_status ) {
 
-			update_post_meta( $invoice->get_id(), 'refunded_remotely', 1 );
+            update_post_meta( $invoice->get_id(), 'refunded_remotely', 1 );
 
-			if ( ! $invoice->is_refunded() ) {
-				$invoice->update_status( 'wpi-refunded', $posted['reason_code'] );
-			}
+            if ( ! $invoice->is_refunded() ) {
+                $invoice->update_status( 'wpi-refunded', $posted['reason_code'] );
+            }
 
-			return wpinv_error_log( $posted['reason_code'], false );
-		}
+            return wpinv_error_log( $posted['reason_code'], false );
+        }
 
-		// Process payments.
-		if ( 'completed' === $payment_status ) {
+        // Process payments.
+        if ( 'completed' === $payment_status ) {
 
-			if ( $invoice->is_paid() && 'wpi_processing' != $invoice->get_status() ) {
-				return wpinv_error_log( 'Aborting, Invoice #' . $invoice->get_number() . ' is already paid.', false );
-			}
+            if ( $invoice->is_paid() && 'wpi_processing' != $invoice->get_status() ) {
+                return wpinv_error_log( 'Aborting, Invoice #' . $invoice->get_number() . ' is already paid.', false );
+            }
 
-			$this->validate_ipn_amount( $invoice, $posted['mc_gross'] );
+            $this->validate_ipn_amount( $invoice, $posted['mc_gross'] );
 
-			$note = '';
+            $note = '';
 
-			if ( ! empty( $posted['mc_fee'] ) ) {
-				$note = sprintf( __( 'PayPal Transaction Fee %s.', 'invoicing' ), sanitize_text_field( $posted['mc_fee'] ) );
-			}
+            if ( ! empty( $posted['mc_fee'] ) ) {
+                $note = sprintf( __( 'PayPal Transaction Fee %s.', 'invoicing' ), sanitize_text_field( $posted['mc_fee'] ) );
+            }
 
-			if ( ! empty( $posted['payer_status'] ) ) {
-				$note = ' ' . sprintf( __( 'Buyer status %s.', 'invoicing' ), sanitize_text_field( $posted['payer_status'] ) );
-			}
+            if ( ! empty( $posted['payer_status'] ) ) {
+                $note = ' ' . sprintf( __( 'Buyer status %s.', 'invoicing' ), sanitize_text_field( $posted['payer_status'] ) );
+            }
 
-			$invoice->mark_paid( ( ! empty( $posted['txn_id'] ) ? sanitize_text_field( $posted['txn_id'] ) : '' ), trim( $note ) );
-			return wpinv_error_log( 'Invoice marked as paid.', false );
+            $invoice->mark_paid( ( ! empty( $posted['txn_id'] ) ? sanitize_text_field( $posted['txn_id'] ) : '' ), trim( $note ) );
+            return wpinv_error_log( 'Invoice marked as paid.', false );
 
-		}
+        }
 
-		// Pending payments.
-		if ( 'pending' === $payment_status ) {
+        // Pending payments.
+        if ( 'pending' === $payment_status ) {
 
-			/* translators: %s: pending reason. */
-			$invoice->update_status( 'wpi-onhold', wp_sprintf( __( 'Payment pending (%s).', 'invoicing' ), $posted['pending_reason'] ) );
-			$invoice->add_note( wp_sprintf( __( 'Payment pending (%s).', 'invoicing' ), $posted['pending_reason'] ), false, false, true );
+            /* translators: %s: pending reason. */
+            $invoice->update_status( 'wpi-onhold', wp_sprintf( __( 'Payment pending (%s).', 'invoicing' ), $posted['pending_reason'] ) );
+            $invoice->add_note( wp_sprintf( __( 'Payment pending (%s).', 'invoicing' ), $posted['pending_reason'] ), false, false, true );
 
-			return wpinv_error_log( 'Invoice marked as "payment held".', false );
-		}
+            return wpinv_error_log( 'Invoice marked as "payment held".', false );
+        }
 
-		/* translators: %s: payment status. */
-		$invoice->update_status( 'wpi-failed', sprintf( __( 'Payment %s via IPN.', 'invoicing' ), sanitize_text_field( $posted['payment_status'] ) ) );
+        /* translators: %s: payment status. */
+        $invoice->update_status( 'wpi-failed', sprintf( __( 'Payment %s via IPN.', 'invoicing' ), sanitize_text_field( $posted['payment_status'] ) ) );
 
-	}
+    }
 
-	/**
-	 * Handles one time payments.
-	 *
-	 * @param WPInv_Invoice $invoice  Invoice object.
-	 * @param array    $posted Posted data.
-	 */
-	protected function ipn_txn_cart( $invoice, $posted ) {
-		$this->ipn_txn_web_accept( $invoice, $posted );
-	}
+    /**
+     * Handles one time payments.
+     *
+     * @param WPInv_Invoice $invoice  Invoice object.
+     * @param array    $posted Posted data.
+     */
+    protected function ipn_txn_cart( $invoice, $posted ) {
+        $this->ipn_txn_web_accept( $invoice, $posted );
+    }
 
-	/**
-	 * Handles subscription sign ups.
-	 *
-	 * @param WPInv_Invoice $invoice  Invoice object.
-	 * @param array    $posted Posted data.
-	 */
-	protected function ipn_txn_subscr_signup( $invoice, $posted ) {
+    /**
+     * Handles subscription sign ups.
+     *
+     * @param WPInv_Invoice $invoice  Invoice object.
+     * @param array    $posted Posted data.
+     */
+    protected function ipn_txn_subscr_signup( $invoice, $posted ) {
 
-		wpinv_error_log( 'Processing subscription signup', false );
+        wpinv_error_log( 'Processing subscription signup', false );
 
-		// Make sure the invoice has a subscription.
-		$subscription = getpaid_get_invoice_subscription( $invoice );
+        // Make sure the invoice has a subscription.
+        $subscription = getpaid_get_invoice_subscription( $invoice );
 
-		if ( empty( $subscription ) ) {
-			return wpinv_error_log( 'Aborting, Subscription for the invoice ' . $invoice->get_id() . ' not found', false );
-		}
+        if ( empty( $subscription ) ) {
+            return wpinv_error_log( 'Aborting, Subscription for the invoice ' . $invoice->get_id() . ' not found', false );
+        }
 
-		wpinv_error_log( 'Found subscription #' . $subscription->get_id(), false );
+        wpinv_error_log( 'Found subscription #' . $subscription->get_id(), false );
 
-		// Validate the IPN.
-		$business_email = isset( $posted['business'] ) && is_email( $posted['business'] ) ? trim( $posted['business'] ) : trim( $posted['receiver_email'] );
-		$this->validate_ipn_receiver_email( $invoice, $business_email );
-		$this->validate_ipn_currency( $invoice, $posted['mc_currency'] );
+        // Validate the IPN.
+        $business_email = isset( $posted['business'] ) && is_email( $posted['business'] ) ? trim( $posted['business'] ) : trim( $posted['receiver_email'] );
+        $this->validate_ipn_receiver_email( $invoice, $business_email );
+        $this->validate_ipn_currency( $invoice, $posted['mc_currency'] );
 
-		// Activate the subscription.
-		$duration = strtotime( $subscription->get_expiration() ) - strtotime( $subscription->get_date_created() );
-		$subscription->set_date_created( current_time( 'mysql' ) );
-		$subscription->set_expiration( date( 'Y-m-d H:i:s', ( current_time( 'timestamp' ) + $duration ) ) );
-		$subscription->set_profile_id( sanitize_text_field( $posted['subscr_id'] ) );
-		$subscription->activate();
+        // Activate the subscription.
+        $duration = strtotime( $subscription->get_expiration() ) - strtotime( $subscription->get_date_created() );
+        $subscription->set_date_created( current_time( 'mysql' ) );
+        $subscription->set_expiration( date( 'Y-m-d H:i:s', ( current_time( 'timestamp' ) + $duration ) ) );
+        $subscription->set_profile_id( sanitize_text_field( $posted['subscr_id'] ) );
+        $subscription->activate();
 
-		// Set the transaction id.
-		if ( ! empty( $posted['txn_id'] ) ) {
-			$invoice->add_note( sprintf( __( 'PayPal Transaction ID: %s', 'invoicing' ), $posted['txn_id'] ), false, false, true );
-			$invoice->set_transaction_id( $posted['txn_id'] );
-		}
+        // Set the transaction id.
+        if ( ! empty( $posted['txn_id'] ) ) {
+            $invoice->add_note( sprintf( __( 'PayPal Transaction ID: %s', 'invoicing' ), $posted['txn_id'] ), false, false, true );
+            $invoice->set_transaction_id( $posted['txn_id'] );
+        }
 
-		// Update the payment status.
-		$invoice->mark_paid();
+        // Update the payment status.
+        $invoice->mark_paid();
 
-		$invoice->add_note( sprintf( __( 'PayPal Subscription ID: %s', 'invoicing' ), $posted['subscr_id'] ), false, false, true );
+        $invoice->add_note( sprintf( __( 'PayPal Subscription ID: %s', 'invoicing' ), $posted['subscr_id'] ), false, false, true );
 
-		wpinv_error_log( 'Subscription started.', false );
-	}
+        wpinv_error_log( 'Subscription started.', false );
+    }
 
-	/**
-	 * Handles subscription renewals.
-	 *
-	 * @param WPInv_Invoice $invoice  Invoice object.
-	 * @param array    $posted Posted data.
-	 */
-	protected function ipn_txn_subscr_payment( $invoice, $posted ) {
+    /**
+     * Handles subscription renewals.
+     *
+     * @param WPInv_Invoice $invoice  Invoice object.
+     * @param array    $posted Posted data.
+     */
+    protected function ipn_txn_subscr_payment( $invoice, $posted ) {
 
-		// Make sure the invoice has a subscription.
-		$subscription = getpaid_subscriptions()->get_invoice_subscription( $invoice );
+        // Make sure the invoice has a subscription.
+        $subscription = getpaid_subscriptions()->get_invoice_subscription( $invoice );
 
-		if ( empty( $subscription ) ) {
-			return wpinv_error_log( 'Aborting, Subscription for the invoice ' . $invoice->get_id() . ' not found', false );
-		}
+        if ( empty( $subscription ) ) {
+            return wpinv_error_log( 'Aborting, Subscription for the invoice ' . $invoice->get_id() . ' not found', false );
+        }
 
-		wpinv_error_log( 'Found subscription #' . $subscription->get_id(), false );
+        wpinv_error_log( 'Found subscription #' . $subscription->get_id(), false );
 
-		// PayPal sends a subscr_payment for the first payment too.
-		$date_completed = getpaid_format_date( $invoice->get_date_completed() );
-		$date_created   = getpaid_format_date( $invoice->get_date_created() );
-		$today_date     = getpaid_format_date( current_time( 'mysql' ) );
-		$payment_date   = getpaid_format_date( $posted['payment_date'] );
-		$subscribe_date = getpaid_format_date( $subscription->get_date_created() );
-		$dates          = array_filter( compact( 'date_completed', 'date_created', 'subscribe_date' ) );
+        // PayPal sends a subscr_payment for the first payment too.
+        $date_completed = getpaid_format_date( $invoice->get_date_completed() );
+        $date_created   = getpaid_format_date( $invoice->get_date_created() );
+        $today_date     = getpaid_format_date( current_time( 'mysql' ) );
+        $payment_date   = getpaid_format_date( $posted['payment_date'] );
+        $subscribe_date = getpaid_format_date( $subscription->get_date_created() );
+        $dates          = array_filter( compact( 'date_completed', 'date_created', 'subscribe_date' ) );
 
-		foreach ( $dates as $date ) {
+        foreach ( $dates as $date ) {
 
-			if ( $date !== $today_date && $date !== $payment_date ) {
-				continue;
-			}
+            if ( $date !== $today_date && $date !== $payment_date ) {
+                continue;
+            }
 
-			if ( ! empty( $posted['txn_id'] ) ) {
-				$invoice->set_transaction_id( sanitize_text_field( $posted['txn_id'] ) );
-				$invoice->add_note( wp_sprintf( __( 'PayPal Transaction ID: %s', 'invoicing' ), sanitize_text_field( $posted['txn_id'] ) ), false, false, true );
-			}
+            if ( ! empty( $posted['txn_id'] ) ) {
+                $invoice->set_transaction_id( sanitize_text_field( $posted['txn_id'] ) );
+                $invoice->add_note( wp_sprintf( __( 'PayPal Transaction ID: %s', 'invoicing' ), sanitize_text_field( $posted['txn_id'] ) ), false, false, true );
+            }
 
-			return $invoice->mark_paid();
-
-		}
+            return $invoice->mark_paid();
+
+        }
 
-		wpinv_error_log( 'Processing subscription renewal payment for the invoice ' . $invoice->get_id(), false );
-
-		// Abort if the payment is already recorded.
-		if ( wpinv_get_id_by_transaction_id( $posted['txn_id'] ) ) {
-			return wpinv_error_log( 'Aborting, Transaction ' . $posted['txn_id'] . ' has already been processed', false );
-		}
-
-		$args = array(
-			'transaction_id' => $posted['txn_id'],
-			'gateway'        => $this->id,
-		);
-
-		$invoice = wpinv_get_invoice( $subscription->add_payment( $args ) );
+        wpinv_error_log( 'Processing subscription renewal payment for the invoice ' . $invoice->get_id(), false );
+
+        // Abort if the payment is already recorded.
+        if ( wpinv_get_id_by_transaction_id( $posted['txn_id'] ) ) {
+            return wpinv_error_log( 'Aborting, Transaction ' . $posted['txn_id'] . ' has already been processed', false );
+        }
+
+        $args = array(
+            'transaction_id' => $posted['txn_id'],
+            'gateway'        => $this->id,
+        );
+
+        $invoice = wpinv_get_invoice( $subscription->add_payment( $args ) );
 
-		if ( empty( $invoice ) ) {
-			return;
-		}
+        if ( empty( $invoice ) ) {
+            return;
+        }
 
-		$invoice->add_note( wp_sprintf( __( 'PayPal Transaction ID: %s', 'invoicing' ), $posted['txn_id'] ), false, false, true );
-		$invoice->add_note( wp_sprintf( __( 'PayPal Subscription ID: %s', 'invoicing' ), $posted['subscr_id'] ), false, false, true );
+        $invoice->add_note( wp_sprintf( __( 'PayPal Transaction ID: %s', 'invoicing' ), $posted['txn_id'] ), false, false, true );
+        $invoice->add_note( wp_sprintf( __( 'PayPal Subscription ID: %s', 'invoicing' ), $posted['subscr_id'] ), false, false, true );
 
-		$subscription->renew();
-		wpinv_error_log( 'Subscription renewed.', false );
+        $subscription->renew();
+        wpinv_error_log( 'Subscription renewed.', false );
 
-	}
+    }
 
-	/**
-	 * Handles subscription cancelations.
-	 *
-	 * @param WPInv_Invoice $invoice  Invoice object.
-	 */
-	protected function ipn_txn_subscr_cancel( $invoice ) {
+    /**
+     * Handles subscription cancelations.
+     *
+     * @param WPInv_Invoice $invoice  Invoice object.
+     */
+    protected function ipn_txn_subscr_cancel( $invoice ) {
 
-		// Make sure the invoice has a subscription.
-		$subscription = getpaid_subscriptions()->get_invoice_subscription( $invoice );
-
-		if ( empty( $subscription ) ) {
-			return wpinv_error_log( 'Aborting, Subscription for the invoice ' . $invoice->get_id() . ' not found', false );
-		}
-
-		wpinv_error_log( 'Processing subscription cancellation for the invoice ' . $invoice->get_id(), false );
-		$subscription->cancel();
-		wpinv_error_log( 'Subscription cancelled.', false );
+        // Make sure the invoice has a subscription.
+        $subscription = getpaid_subscriptions()->get_invoice_subscription( $invoice );
+
+        if ( empty( $subscription ) ) {
+            return wpinv_error_log( 'Aborting, Subscription for the invoice ' . $invoice->get_id() . ' not found', false );
+        }
+
+        wpinv_error_log( 'Processing subscription cancellation for the invoice ' . $invoice->get_id(), false );
+        $subscription->cancel();
+        wpinv_error_log( 'Subscription cancelled.', false );
 
-	}
+    }
 
-	/**
-	 * Handles subscription completions.
-	 *
-	 * @param WPInv_Invoice $invoice  Invoice object.
-	 * @param array    $posted Posted data.
-	 */
-	protected function ipn_txn_subscr_eot( $invoice ) {
+    /**
+     * Handles subscription completions.
+     *
+     * @param WPInv_Invoice $invoice  Invoice object.
+     * @param array    $posted Posted data.
+     */
+    protected function ipn_txn_subscr_eot( $invoice ) {
 
-		// Make sure the invoice has a subscription.
-		$subscription = getpaid_subscriptions()->get_invoice_subscription( $invoice );
+        // Make sure the invoice has a subscription.
+        $subscription = getpaid_subscriptions()->get_invoice_subscription( $invoice );
 
-		if ( empty( $subscription ) ) {
-			return wpinv_error_log( 'Aborting, Subscription for the invoice ' . $invoice->get_id() . ' not found', false );
-		}
+        if ( empty( $subscription ) ) {
+            return wpinv_error_log( 'Aborting, Subscription for the invoice ' . $invoice->get_id() . ' not found', false );
+        }
 
-		wpinv_error_log( 'Processing subscription end of life for the invoice ' . $invoice->get_id(), false );
-		$subscription->complete();
-		wpinv_error_log( 'Subscription completed.', false );
+        wpinv_error_log( 'Processing subscription end of life for the invoice ' . $invoice->get_id(), false );
+        $subscription->complete();
+        wpinv_error_log( 'Subscription completed.', false );
 
-	}
+    }
 
-	/**
-	 * Handles subscription fails.
-	 *
-	 * @param WPInv_Invoice $invoice  Invoice object.
-	 * @param array    $posted Posted data.
-	 */
-	protected function ipn_txn_subscr_failed( $invoice ) {
+    /**
+     * Handles subscription fails.
+     *
+     * @param WPInv_Invoice $invoice  Invoice object.
+     * @param array    $posted Posted data.
+     */
+    protected function ipn_txn_subscr_failed( $invoice ) {
 
-		// Make sure the invoice has a subscription.
-		$subscription = getpaid_subscriptions()->get_invoice_subscription( $invoice );
+        // Make sure the invoice has a subscription.
+        $subscription = getpaid_subscriptions()->get_invoice_subscription( $invoice );
 
-		if ( empty( $subscription ) ) {
-			return wpinv_error_log( 'Aborting, Subscription for the invoice ' . $invoice->get_id() . ' not found', false );
-		}
+        if ( empty( $subscription ) ) {
+            return wpinv_error_log( 'Aborting, Subscription for the invoice ' . $invoice->get_id() . ' not found', false );
+        }
 
-		wpinv_error_log( 'Processing subscription payment failure for the invoice ' . $invoice->get_id(), false );
-		$subscription->failing();
-		wpinv_error_log( 'Subscription marked as failing.', false );
+        wpinv_error_log( 'Processing subscription payment failure for the invoice ' . $invoice->get_id(), false );
+        $subscription->failing();
+        wpinv_error_log( 'Subscription marked as failing.', false );
 
-	}
+    }
 
-	/**
-	 * Handles subscription suspensions.
-	 *
-	 * @param WPInv_Invoice $invoice  Invoice object.
-	 * @param array    $posted Posted data.
-	 */
-	protected function ipn_txn_recurring_payment_suspended_due_to_max_failed_payment( $invoice ) {
+    /**
+     * Handles subscription suspensions.
+     *
+     * @param WPInv_Invoice $invoice  Invoice object.
+     * @param array    $posted Posted data.
+     */
+    protected function ipn_txn_recurring_payment_suspended_due_to_max_failed_payment( $invoice ) {
 
-		// Make sure the invoice has a subscription.
-		$subscription = getpaid_subscriptions()->get_invoice_subscription( $invoice );
+        // Make sure the invoice has a subscription.
+        $subscription = getpaid_subscriptions()->get_invoice_subscription( $invoice );
 
-		if ( empty( $subscription ) ) {
-			return wpinv_error_log( 'Aborting, Subscription for the invoice ' . $invoice->get_id() . ' not found', false );
-		}
-
-		wpinv_error_log( 'Processing subscription cancellation due to max failed payment for the invoice ' . $invoice->get_id(), false );
-		$subscription->cancel();
-		wpinv_error_log( 'Subscription cancelled.', false );
-	}
+        if ( empty( $subscription ) ) {
+            return wpinv_error_log( 'Aborting, Subscription for the invoice ' . $invoice->get_id() . ' not found', false );
+        }
+
+        wpinv_error_log( 'Processing subscription cancellation due to max failed payment for the invoice ' . $invoice->get_id(), false );
+        $subscription->cancel();
+        wpinv_error_log( 'Subscription cancelled.', false );
+    }
 
 }

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

Indentation +404 added lines, -404 removed lines

@@ -13,97 +13,97 @@ 
 class GetPaid_Paypal_Gateway extends GetPaid_Payment_Gateway {
 
     /**
-	 * Payment method id.
-	 *
-	 * @var string
-	 */
+     * Payment method id.
+     *
+     * @var string
+     */
     public $id = 'paypal';
 
     /**
-	 * An array of features that this gateway supports.
-	 *
-	 * @var array
-	 */
+     * An array of features that this gateway supports.
+     *
+     * @var array
+     */
     protected $supports = array( 'subscription', 'sandbox', 'single_subscription_group' );
 
     /**
-	 * Payment method order.
-	 *
-	 * @var int
-	 */
+     * Payment method order.
+     *
+     * @var int
+     */
     public $order = 1;
 
     /**
-	 * Stores line items to send to PayPal.
-	 *
-	 * @var array
-	 */
+     * Stores line items to send to PayPal.
+     *
+     * @var array
+     */
     protected $line_items = array();
 
     /**
-	 * Endpoint for requests from PayPal.
-	 *
-	 * @var string
-	 */
-	protected $notify_url;
-
-	/**
-	 * Endpoint for requests to PayPal.
-	 *
-	 * @var string
-	 */
+     * Endpoint for requests from PayPal.
+     *
+     * @var string
+     */
+    protected $notify_url;
+
+    /**
+     * Endpoint for requests to PayPal.
+     *
+     * @var string
+     */
     protected $endpoint;
 
     /**
-	 * Currencies this gateway is allowed for.
-	 *
-	 * @var array
-	 */
-	public $currencies = array( 'AUD', 'BRL', 'CAD', 'MXN', 'NZD', 'HKD', 'SGD', 'USD', 'EUR', 'JPY', 'TRY', 'NOK', 'CZK', 'DKK', 'HUF', 'ILS', 'MYR', 'PHP', 'PLN', 'SEK', 'CHF', 'TWD', 'THB', 'GBP', 'RMB', 'RUB', 'INR' );
+     * Currencies this gateway is allowed for.
+     *
+     * @var array
+     */
+    public $currencies = array( 'AUD', 'BRL', 'CAD', 'MXN', 'NZD', 'HKD', 'SGD', 'USD', 'EUR', 'JPY', 'TRY', 'NOK', 'CZK', 'DKK', 'HUF', 'ILS', 'MYR', 'PHP', 'PLN', 'SEK', 'CHF', 'TWD', 'THB', 'GBP', 'RMB', 'RUB', 'INR' );
 
     /**
-	 * URL to view a transaction.
-	 *
-	 * @var string
-	 */
+     * URL to view a transaction.
+     *
+     * @var string
+     */
     public $view_transaction_url = 'https://www.{sandbox}paypal.com/activity/payment/%s';
 
     /**
-	 * URL to view a subscription.
-	 *
-	 * @var string
-	 */
-	public $view_subscription_url = 'https://www.{sandbox}paypal.com/cgi-bin/webscr?cmd=_profile-recurring-payments&encrypted_profile_id=%s';
+     * URL to view a subscription.
+     *
+     * @var string
+     */
+    public $view_subscription_url = 'https://www.{sandbox}paypal.com/cgi-bin/webscr?cmd=_profile-recurring-payments&encrypted_profile_id=%s';
 
     /**
-	 * Class constructor.
-	 */
-	public function __construct() {
+     * Class constructor.
+     */
+    public function __construct() {
 
         $this->title                = __( 'PayPal Standard', 'invoicing' );
         $this->method_title         = __( 'PayPal Standard', 'invoicing' );
         $this->checkout_button_text = __( 'Proceed to PayPal', 'invoicing' );
         $this->notify_url           = wpinv_get_ipn_url( $this->id );
 
-		add_filter( 'wpinv_subscription_cancel_url', array( $this, 'filter_cancel_subscription_url' ), 10, 2 );
-		add_filter( 'getpaid_paypal_args', array( $this, 'process_subscription' ), 10, 2 );
+        add_filter( 'wpinv_subscription_cancel_url', array( $this, 'filter_cancel_subscription_url' ), 10, 2 );
+        add_filter( 'getpaid_paypal_args', array( $this, 'process_subscription' ), 10, 2 );
         add_filter( 'getpaid_paypal_sandbox_notice', array( $this, 'sandbox_notice' ) );
-		add_filter( 'getpaid_get_paypal_connect_url', array( $this, 'maybe_get_connect_url' ), 10, 2 );
-		add_action( 'getpaid_authenticated_admin_action_connect_paypal', array( $this, 'connect_paypal' ) );
-		add_action( 'wpinv_paypal_connect', array( $this, 'display_connect_buttons' ) );
-		parent::__construct();
+        add_filter( 'getpaid_get_paypal_connect_url', array( $this, 'maybe_get_connect_url' ), 10, 2 );
+        add_action( 'getpaid_authenticated_admin_action_connect_paypal', array( $this, 'connect_paypal' ) );
+        add_action( 'wpinv_paypal_connect', array( $this, 'display_connect_buttons' ) );
+        parent::__construct();
     }
 
     /**
-	 * Process Payment.
-	 *
-	 *
-	 * @param WPInv_Invoice $invoice Invoice.
-	 * @param array $submission_data Posted checkout fields.
-	 * @param GetPaid_Payment_Form_Submission $submission Checkout submission.
-	 * @return array
-	 */
-	public function process_payment( $invoice, $submission_data, $submission ) {
+     * Process Payment.
+     *
+     *
+     * @param WPInv_Invoice $invoice Invoice.
+     * @param array $submission_data Posted checkout fields.
+     * @param GetPaid_Payment_Form_Submission $submission Checkout submission.
+     * @return array
+     */
+    public function process_payment( $invoice, $submission_data, $submission ) {
 
         // Get redirect url.
         $paypal_redirect = $this->get_request_url( $invoice );
@@ -126,15 +126,15 @@ 
     }
 
     /**
-	 * Get the PayPal request URL for an invoice.
-	 *
-	 * @param  WPInv_Invoice $invoice Invoice object.
-	 * @return string
-	 */
-	public function get_request_url( $invoice ) {
+     * Get the PayPal request URL for an invoice.
+     *
+     * @param  WPInv_Invoice $invoice Invoice object.
+     * @return string
+     */
+    public function get_request_url( $invoice ) {
 
         // Endpoint for this request
-		$this->endpoint    = $this->is_sandbox( $invoice ) ? 'https://www.sandbox.paypal.com/cgi-bin/webscr?test_ipn=1&' : 'https://www.paypal.com/cgi-bin/webscr?';
+        $this->endpoint    = $this->is_sandbox( $invoice ) ? 'https://www.sandbox.paypal.com/cgi-bin/webscr?test_ipn=1&' : 'https://www.paypal.com/cgi-bin/webscr?';
 
         // Retrieve paypal args.
         $paypal_args       = map_deep( $this->get_paypal_args( $invoice ), 'urlencode' );
@@ -147,45 +147,45 @@ 
 
         return add_query_arg( $paypal_args, $this->endpoint );
 
-	}
+    }
 
     /**
-	 * Get PayPal Args for passing to PP.
-	 *
-	 * @param  WPInv_Invoice $invoice Invoice object.
-	 * @return array
-	 */
-	protected function get_paypal_args( $invoice ) {
+     * Get PayPal Args for passing to PP.
+     *
+     * @param  WPInv_Invoice $invoice Invoice object.
+     * @return array
+     */
+    protected function get_paypal_args( $invoice ) {
 
         // Whether or not to send the line items as one item.
-		$force_one_line_item = apply_filters( 'getpaid_paypal_force_one_line_item', true, $invoice );
-
-		if ( $invoice->is_recurring() || ( wpinv_use_taxes() && wpinv_prices_include_tax() ) ) {
-			$force_one_line_item = true;
-		}
-
-		$paypal_args = apply_filters(
-			'getpaid_paypal_args',
-			array_merge(
-				$this->get_transaction_args( $invoice ),
-				$this->get_line_item_args( $invoice, $force_one_line_item )
-			),
-			$invoice
-		);
-
-		return $this->fix_request_length( $invoice, $paypal_args );
+        $force_one_line_item = apply_filters( 'getpaid_paypal_force_one_line_item', true, $invoice );
+
+        if ( $invoice->is_recurring() || ( wpinv_use_taxes() && wpinv_prices_include_tax() ) ) {
+            $force_one_line_item = true;
+        }
+
+        $paypal_args = apply_filters(
+            'getpaid_paypal_args',
+            array_merge(
+                $this->get_transaction_args( $invoice ),
+                $this->get_line_item_args( $invoice, $force_one_line_item )
+            ),
+            $invoice
+        );
+
+        return $this->fix_request_length( $invoice, $paypal_args );
     }
 
     /**
-	 * Get transaction args for paypal request.
-	 *
-	 * @param WPInv_Invoice $invoice Invoice object.
-	 * @return array
-	 */
-	protected function get_transaction_args( $invoice ) {
-
-		$email = $this->is_sandbox( $invoice ) ? wpinv_get_option( 'paypal_sandbox_email', wpinv_get_option( 'paypal_email', '' ) ) : wpinv_get_option( 'paypal_email', '' );
-		return array(
+     * Get transaction args for paypal request.
+     *
+     * @param WPInv_Invoice $invoice Invoice object.
+     * @return array
+     */
+    protected function get_transaction_args( $invoice ) {
+
+        $email = $this->is_sandbox( $invoice ) ? wpinv_get_option( 'paypal_sandbox_email', wpinv_get_option( 'paypal_email', '' ) ) : wpinv_get_option( 'paypal_email', '' );
+        return array(
             'cmd'           => '_cart',
             'business'      => $email,
             'no_shipping'   => '1',
@@ -210,16 +210,16 @@ 
     }
 
     /**
-	 * Get line item args for paypal request.
-	 *
-	 * @param  WPInv_Invoice $invoice Invoice object.
-	 * @param  bool     $force_one_line_item Create only one item for this invoice.
-	 * @return array
-	 */
-	protected function get_line_item_args( $invoice, $force_one_line_item = false ) {
+     * Get line item args for paypal request.
+     *
+     * @param  WPInv_Invoice $invoice Invoice object.
+     * @param  bool     $force_one_line_item Create only one item for this invoice.
+     * @return array
+     */
+    protected function get_line_item_args( $invoice, $force_one_line_item = false ) {
 
         // Maybe send invoice as a single item.
-		if ( $force_one_line_item ) {
+        if ( $force_one_line_item ) {
             return $this->get_line_item_args_single_item( $invoice );
         }
 
@@ -239,134 +239,134 @@ 
             $line_item_args['discount_amount_cart'] = wpinv_sanitize_amount( (float) $invoice->get_total_discount(), 2 );
         }
 
-		return array_merge( $line_item_args, $this->get_line_items() );
+        return array_merge( $line_item_args, $this->get_line_items() );
 
     }
 
     /**
-	 * Get line item args for paypal request as a single line item.
-	 *
-	 * @param  WPInv_Invoice $invoice Invoice object.
-	 * @return array
-	 */
-	protected function get_line_item_args_single_item( $invoice ) {
-		$this->delete_line_items();
+     * Get line item args for paypal request as a single line item.
+     *
+     * @param  WPInv_Invoice $invoice Invoice object.
+     * @return array
+     */
+    protected function get_line_item_args_single_item( $invoice ) {
+        $this->delete_line_items();
 
         $item_name = wp_sprintf( __( 'Invoice %s', 'invoicing' ), $invoice->get_number() );
-		$this->add_line_item( $item_name, 1, wpinv_round_amount( (float) $invoice->get_total(), 2, true ), $invoice->get_id() );
+        $this->add_line_item( $item_name, 1, wpinv_round_amount( (float) $invoice->get_total(), 2, true ), $invoice->get_id() );
 
-		return $this->get_line_items();
+        return $this->get_line_items();
     }
 
     /**
-	 * Return all line items.
-	 */
-	protected function get_line_items() {
-		return $this->line_items;
-	}
+     * Return all line items.
+     */
+    protected function get_line_items() {
+        return $this->line_items;
+    }
 
     /**
-	 * Remove all line items.
-	 */
-	protected function delete_line_items() {
-		$this->line_items = array();
+     * Remove all line items.
+     */
+    protected function delete_line_items() {
+        $this->line_items = array();
     }
 
     /**
-	 * Prepare line items to send to paypal.
-	 *
-	 * @param  WPInv_Invoice $invoice Invoice object.
-	 */
-	protected function prepare_line_items( $invoice ) {
-		$this->delete_line_items();
-
-		// Items.
-		foreach ( $invoice->get_items() as $item ) {
-			$amount   = $item->get_price();
-			$quantity = $invoice->get_template() == 'amount' ? 1 : $item->get_quantity();
-			$this->add_line_item( $item->get_raw_name(), $quantity, $amount, $item->get_id() );
+     * Prepare line items to send to paypal.
+     *
+     * @param  WPInv_Invoice $invoice Invoice object.
+     */
+    protected function prepare_line_items( $invoice ) {
+        $this->delete_line_items();
+
+        // Items.
+        foreach ( $invoice->get_items() as $item ) {
+            $amount   = $item->get_price();
+            $quantity = $invoice->get_template() == 'amount' ? 1 : $item->get_quantity();
+            $this->add_line_item( $item->get_raw_name(), $quantity, $amount, $item->get_id() );
         }
 
         // Fees.
-		foreach ( $invoice->get_fees() as $fee => $data ) {
+        foreach ( $invoice->get_fees() as $fee => $data ) {
             $this->add_line_item( $fee, 1, wpinv_sanitize_amount( $data['initial_fee'] ) );
         }
 
     }
 
     /**
-	 * Add PayPal Line Item.
-	 *
-	 * @param  string $item_name Item name.
-	 * @param  float    $quantity Item quantity.
-	 * @param  float  $amount Amount.
-	 * @param  string $item_number Item number.
-	 */
-	protected function add_line_item( $item_name, $quantity = 1, $amount = 0.0, $item_number = '' ) {
-		$index = ( count( $this->line_items ) / 4 ) + 1;
-
-		/**
-		 * Prevent error "Things don't appear to be working at the moment. (https://www.sandbox.paypal.com/webapps/hermes/error)"
-		 */
-		$item_name = str_replace( "#", "", $item_name );
-
-		$item = apply_filters(
-			'getpaid_paypal_line_item',
-			array(
-				'item_name'   => html_entity_decode( getpaid_limit_length( $item_name ? wp_strip_all_tags( $item_name ) : __( 'Item', 'invoicing' ), 127 ), ENT_NOQUOTES, 'UTF-8' ),
-				'quantity'    => (float) $quantity,
-				'amount'      => wpinv_sanitize_amount( (float) $amount, 2 ),
-				'item_number' => $item_number,
-			),
-			$item_name,
-			$quantity,
-			$amount,
-			$item_number
-		);
-
-		$this->line_items[ 'item_name_' . $index ]   = getpaid_limit_length( $item['item_name'], 127 );
+     * Add PayPal Line Item.
+     *
+     * @param  string $item_name Item name.
+     * @param  float    $quantity Item quantity.
+     * @param  float  $amount Amount.
+     * @param  string $item_number Item number.
+     */
+    protected function add_line_item( $item_name, $quantity = 1, $amount = 0.0, $item_number = '' ) {
+        $index = ( count( $this->line_items ) / 4 ) + 1;
+
+        /**
+         * Prevent error "Things don't appear to be working at the moment. (https://www.sandbox.paypal.com/webapps/hermes/error)"
+         */
+        $item_name = str_replace( "#", "", $item_name );
+
+        $item = apply_filters(
+            'getpaid_paypal_line_item',
+            array(
+                'item_name'   => html_entity_decode( getpaid_limit_length( $item_name ? wp_strip_all_tags( $item_name ) : __( 'Item', 'invoicing' ), 127 ), ENT_NOQUOTES, 'UTF-8' ),
+                'quantity'    => (float) $quantity,
+                'amount'      => wpinv_sanitize_amount( (float) $amount, 2 ),
+                'item_number' => $item_number,
+            ),
+            $item_name,
+            $quantity,
+            $amount,
+            $item_number
+        );
+
+        $this->line_items[ 'item_name_' . $index ]   = getpaid_limit_length( $item['item_name'], 127 );
         $this->line_items[ 'quantity_' . $index ]    = $item['quantity'];
 
         // The price or amount of the product, service, or contribution, not including shipping, handling, or tax.
-		$this->line_items[ 'amount_' . $index ]      = $item['amount'] * $item['quantity'];
-		$this->line_items[ 'item_number_' . $index ] = getpaid_limit_length( $item['item_number'], 127 );
+        $this->line_items[ 'amount_' . $index ]      = $item['amount'] * $item['quantity'];
+        $this->line_items[ 'item_number_' . $index ] = getpaid_limit_length( $item['item_number'], 127 );
     }
 
     /**
-	 * If the default request with line items is too long, generate a new one with only one line item.
-	 *
-	 * https://support.microsoft.com/en-us/help/208427/maximum-url-length-is-2-083-characters-in-internet-explorer.
-	 *
-	 * @param WPInv_Invoice $invoice Invoice to be sent to Paypal.
-	 * @param array    $paypal_args Arguments sent to Paypal in the request.
-	 * @return array
-	 */
-	protected function fix_request_length( $invoice, $paypal_args ) {
-		$max_paypal_length = 2083;
-		$query_candidate   = http_build_query( $paypal_args, '', '&' );
-
-		if ( strlen( $this->endpoint . $query_candidate ) <= $max_paypal_length ) {
-			return $paypal_args;
-		}
-
-		return apply_filters(
-			'getpaid_paypal_args',
-			array_merge(
-				$this->get_transaction_args( $invoice ),
-				$this->get_line_item_args( $invoice, true )
-			),
-			$invoice
-		);
+     * If the default request with line items is too long, generate a new one with only one line item.
+     *
+     * https://support.microsoft.com/en-us/help/208427/maximum-url-length-is-2-083-characters-in-internet-explorer.
+     *
+     * @param WPInv_Invoice $invoice Invoice to be sent to Paypal.
+     * @param array    $paypal_args Arguments sent to Paypal in the request.
+     * @return array
+     */
+    protected function fix_request_length( $invoice, $paypal_args ) {
+        $max_paypal_length = 2083;
+        $query_candidate   = http_build_query( $paypal_args, '', '&' );
+
+        if ( strlen( $this->endpoint . $query_candidate ) <= $max_paypal_length ) {
+            return $paypal_args;
+        }
+
+        return apply_filters(
+            'getpaid_paypal_args',
+            array_merge(
+                $this->get_transaction_args( $invoice ),
+                $this->get_line_item_args( $invoice, true )
+            ),
+            $invoice
+        );
 
     }
 
     /**
-	 * Processes recurring invoices.
-	 *
-	 * @param  array $paypal_args PayPal args.
-	 * @param  WPInv_Invoice    $invoice Invoice object.
-	 */
-	public function process_subscription( $paypal_args, $invoice ) {
+     * Processes recurring invoices.
+     *
+     * @param  array $paypal_args PayPal args.
+     * @param  WPInv_Invoice    $invoice Invoice object.
+     */
+    public function process_subscription( $paypal_args, $invoice ) {
 
         // Make sure this is a subscription.
         if ( ! $invoice->is_recurring() || ! $subscription = getpaid_get_invoice_subscription( $invoice ) ) {
@@ -387,21 +387,21 @@ 
         $recurring_amount       = (float) wpinv_sanitize_amount( $invoice->get_recurring_total(), 2 );
         $subscription_item      = $invoice->get_recurring( true );
 
-		// Convert 365 days to 1 year.
-		if ( 'D' == $period && 365 == $interval ) {
-			$period = 'Y';
-			$interval = 1;
-		}
+        // Convert 365 days to 1 year.
+        if ( 'D' == $period && 365 == $interval ) {
+            $period = 'Y';
+            $interval = 1;
+        }
 
         if ( $subscription_item->has_free_trial() ) {
 
             $paypal_args['a1'] = 0 == $initial_amount ? 0 : $initial_amount;
 
-			// Trial period length.
-			$paypal_args['p1'] = $subscription_item->get_trial_interval();
+            // Trial period length.
+            $paypal_args['p1'] = $subscription_item->get_trial_interval();
 
-			// Trial period.
-			$paypal_args['t1'] = $subscription_item->get_trial_period();
+            // Trial period.
+            $paypal_args['t1'] = $subscription_item->get_trial_period();
 
         } elseif ( $initial_amount != $recurring_amount ) {
 
@@ -424,40 +424,40 @@ 
         }
 
         // We have a recurring payment
-		if ( ! isset( $param_number ) || 1 == $param_number ) {
+        if ( ! isset( $param_number ) || 1 == $param_number ) {
 
-			// Subscription price
-			$paypal_args['a3'] = $recurring_amount;
+            // Subscription price
+            $paypal_args['a3'] = $recurring_amount;
 
-			// Subscription duration
-			$paypal_args['p3'] = $interval;
+            // Subscription duration
+            $paypal_args['p3'] = $interval;
 
-			// Subscription period
-			$paypal_args['t3'] = $period;
+            // Subscription period
+            $paypal_args['t3'] = $period;
 
         }
 
         // Recurring payments
-		if ( 1 == $bill_times || ( $initial_amount != $recurring_amount && ! $subscription_item->has_free_trial() && 2 == $bill_times ) ) {
+        if ( 1 == $bill_times || ( $initial_amount != $recurring_amount && ! $subscription_item->has_free_trial() && 2 == $bill_times ) ) {
 
-			// Non-recurring payments
-			$paypal_args['src'] = 0;
+            // Non-recurring payments
+            $paypal_args['src'] = 0;
 
-		} else {
+        } else {
 
-			$paypal_args['src'] = 1;
+            $paypal_args['src'] = 1;
 
-			if ( $bill_times > 0 ) {
+            if ( $bill_times > 0 ) {
 
-				// An initial period is being used to charge a sign-up fee
-				if ( $initial_amount != $recurring_amount && ! $subscription_item->has_free_trial() ) {
-					$bill_times--;
-				}
+                // An initial period is being used to charge a sign-up fee
+                if ( $initial_amount != $recurring_amount && ! $subscription_item->has_free_trial() ) {
+                    $bill_times--;
+                }
 
                 // Make sure it's not over the max of 52
                 $paypal_args['srt'] = ( $bill_times <= 52 ? absint( $bill_times ) : 52 );
 
-			}
+            }
         }
 
         // Force return URL so that order description & instructions display
@@ -472,19 +472,19 @@ 
 }
 
         return apply_filters(
-			'getpaid_paypal_subscription_args',
-			$paypal_args,
-			$invoice
+            'getpaid_paypal_subscription_args',
+            $paypal_args,
+            $invoice
         );
 
     }
 
     /**
-	 * Processes ipns and marks payments as complete.
-	 *
-	 * @return void
-	 */
-	public function verify_ipn() {
+     * Processes ipns and marks payments as complete.
+     *
+     * @return void
+     */
+    public function verify_ipn() {
         new GetPaid_Paypal_Gateway_IPN_Handler( $this );
     }
 
@@ -494,19 +494,19 @@ 
     public function sandbox_notice() {
 
         return sprintf(
-			__( 'SANDBOX ENABLED. You can use sandbox testing accounts only. See the %1$sPayPal Sandbox Testing Guide%2$s for more details.', 'invoicing' ),
-			'<a href="https://developer.paypal.com/docs/classic/lifecycle/ug_sandbox/">',
-			'</a>'
-		);
+            __( 'SANDBOX ENABLED. You can use sandbox testing accounts only. See the %1$sPayPal Sandbox Testing Guide%2$s for more details.', 'invoicing' ),
+            '<a href="https://developer.paypal.com/docs/classic/lifecycle/ug_sandbox/">',
+            '</a>'
+        );
 
     }
 
-	/**
-	 * Filters the gateway settings.
-	 *
-	 * @param array $admin_settings
-	 */
-	public function admin_settings( $admin_settings ) {
+    /**
+     * Filters the gateway settings.
+     *
+     * @param array $admin_settings
+     */
+    public function admin_settings( $admin_settings ) {
 
         $currencies = sprintf(
             __( 'Supported Currencies: %s', 'invoicing' ),
@@ -516,66 +516,66 @@ 
         $admin_settings['paypal_active']['desc'] .= " ($currencies)";
         $admin_settings['paypal_desc']['std']     = __( 'Pay via PayPal: you can pay with your credit card if you don\'t have a PayPal account.', 'invoicing' );
 
-		// Access tokens.
-		$live_email      = wpinv_get_option( 'paypal_email' );
-		$sandbox_email   = wpinv_get_option( 'paypal_sandbox_email' );
+        // Access tokens.
+        $live_email      = wpinv_get_option( 'paypal_email' );
+        $sandbox_email   = wpinv_get_option( 'paypal_sandbox_email' );
 
-		$admin_settings['paypal_connect'] = array(
-			'type' => 'hook',
-			'id'   => 'paypal_connect',
-			'name' => __( 'Connect to PayPal', 'invoicing' ),
-		);
+        $admin_settings['paypal_connect'] = array(
+            'type' => 'hook',
+            'id'   => 'paypal_connect',
+            'name' => __( 'Connect to PayPal', 'invoicing' ),
+        );
 
         $admin_settings['paypal_email'] = array(
             'type'  => 'text',
-			'class' => 'live-auth-data',
+            'class' => 'live-auth-data',
             'id'    => 'paypal_email',
             'name'  => __( 'Live Email Address', 'invoicing' ),
             'desc'  => __( 'The email address of your PayPal account.', 'invoicing' ),
         );
 
-		$admin_settings['paypal_sandbox_email'] = array(
+        $admin_settings['paypal_sandbox_email'] = array(
             'type'  => 'text',
-			'class' => 'sandbox-auth-data',
+            'class' => 'sandbox-auth-data',
             'id'    => 'paypal_sandbox_email',
             'name'  => __( 'Sandbox Email Address', 'invoicing' ),
             'desc'  => __( 'The email address of your sandbox PayPal account.', 'invoicing' ),
-			'std'   => wpinv_get_option( 'paypal_email', '' ),
+            'std'   => wpinv_get_option( 'paypal_email', '' ),
+        );
+
+        // Client ID and secret.
+        $admin_settings['paypal_client_id'] = array(
+            'type'  => 'text',
+            'class' => 'live-auth-data',
+            'id'    => 'paypal_client_id',
+            'name'  => __( 'Live Client ID', 'invoicing' ),
+            'desc'  => __( 'The client ID of your PayPal account. You can retrieve this from your PayPal developer account.', 'invoicing' ),
+        );
+
+        $admin_settings['paypal_sandbox_client_id'] = array(
+            'type'  => 'text',
+            'class' => 'sandbox-auth-data',
+            'id'    => 'paypal_sandbox_client_id',
+            'name'  => __( 'Sandbox Client ID', 'invoicing' ),
+            'desc'  => __( 'The client ID of your sandbox PayPal account. You can retrieve this from your PayPal developer account.', 'invoicing' ),
+            'std'   => wpinv_get_option( 'paypal_client_id', '' ),
         );
 
-		// Client ID and secret.
-		$admin_settings['paypal_client_id'] = array(
-			'type'  => 'text',
-			'class' => 'live-auth-data',
-			'id'    => 'paypal_client_id',
-			'name'  => __( 'Live Client ID', 'invoicing' ),
-			'desc'  => __( 'The client ID of your PayPal account. You can retrieve this from your PayPal developer account.', 'invoicing' ),
-		);
-
-		$admin_settings['paypal_sandbox_client_id'] = array(
-			'type'  => 'text',
-			'class' => 'sandbox-auth-data',
-			'id'    => 'paypal_sandbox_client_id',
-			'name'  => __( 'Sandbox Client ID', 'invoicing' ),
-			'desc'  => __( 'The client ID of your sandbox PayPal account. You can retrieve this from your PayPal developer account.', 'invoicing' ),
-			'std'   => wpinv_get_option( 'paypal_client_id', '' ),
-		);
-
-		$admin_settings['paypal_secret'] = array(
-			'type'  => 'text',
-			'class' => 'live-auth-data',
-			'id'    => 'paypal_secret',
-			'name'  => __( 'Live Secret', 'invoicing' ),
-			'desc'  => __( 'The secret of your PayPal account. You can retrieve this from your PayPal developer account.', 'invoicing' ),
-		);
-
-		$admin_settings['paypal_sandbox_secret'] = array(
-			'type'  => 'text',
-			'class' => 'sandbox-auth-data',
-			'id'    => 'paypal_sandbox_secret',
-			'name'  => __( 'Sandbox Secret', 'invoicing' ),
-			'desc'  => __( 'The secret of your sandbox PayPal account. You can retrieve this from your PayPal developer account.', 'invoicing' ),
-		);
+        $admin_settings['paypal_secret'] = array(
+            'type'  => 'text',
+            'class' => 'live-auth-data',
+            'id'    => 'paypal_secret',
+            'name'  => __( 'Live Secret', 'invoicing' ),
+            'desc'  => __( 'The secret of your PayPal account. You can retrieve this from your PayPal developer account.', 'invoicing' ),
+        );
+
+        $admin_settings['paypal_sandbox_secret'] = array(
+            'type'  => 'text',
+            'class' => 'sandbox-auth-data',
+            'id'    => 'paypal_sandbox_secret',
+            'name'  => __( 'Sandbox Secret', 'invoicing' ),
+            'desc'  => __( 'The secret of your sandbox PayPal account. You can retrieve this from your PayPal developer account.', 'invoicing' ),
+        );
 
         $admin_settings['paypal_ipn_url'] = array(
             'type'     => 'ipn_url',
@@ -586,57 +586,57 @@ 
             'readonly' => true,
         );
 
-		return $admin_settings;
-	}
-
-	/**
-	 * Retrieves the URL to cancel a subscription.
-	 *
-	 * @param string $url
-	 * @param WPInv_Subscription $subscription
-	 */
-	public function filter_cancel_subscription_url( $url, $subscription ) {
-
-		if ( $this->id !== $subscription->get_gateway() ) {
-			return $url;
-		}
-
-		// Get the PayPal profile ID.
-		$profile_id = $subscription->get_profile_id();
-
-		// Bail if no profile ID.
-		if ( empty( $profile_id ) ) {
-			return $url;
-		}
-
-		$cancel_url = 'https://www.paypal.com/myaccount/autopay/connect/%s/cancel';
-		if ( $this->is_sandbox( $subscription->get_parent_payment() ) ) {
-			$cancel_url = 'https://www.sandbox.paypal.com/myaccount/autopay/connect/%s/cancel';
-		}
-
-		return sprintf( $cancel_url, $profile_id );
-	}
-
-	/**
-	 * Retrieves the PayPal connect URL when using the setup wizzard.
-	 *
-	 *
+        return $admin_settings;
+    }
+
+    /**
+     * Retrieves the URL to cancel a subscription.
+     *
+     * @param string $url
+     * @param WPInv_Subscription $subscription
+     */
+    public function filter_cancel_subscription_url( $url, $subscription ) {
+
+        if ( $this->id !== $subscription->get_gateway() ) {
+            return $url;
+        }
+
+        // Get the PayPal profile ID.
+        $profile_id = $subscription->get_profile_id();
+
+        // Bail if no profile ID.
+        if ( empty( $profile_id ) ) {
+            return $url;
+        }
+
+        $cancel_url = 'https://www.paypal.com/myaccount/autopay/connect/%s/cancel';
+        if ( $this->is_sandbox( $subscription->get_parent_payment() ) ) {
+            $cancel_url = 'https://www.sandbox.paypal.com/myaccount/autopay/connect/%s/cancel';
+        }
+
+        return sprintf( $cancel_url, $profile_id );
+    }
+
+    /**
+     * Retrieves the PayPal connect URL when using the setup wizzard.
+     *
+     *
      * @param array $data
      * @return string
-	 */
-	public static function maybe_get_connect_url( $url = '', $data = array() ) {
-		return self::get_connect_url( false, urldecode( $data['redirect'] ) );
-	}
-
-	/**
-	 * Retrieves the PayPal connect URL.
-	 *
-	 *
+     */
+    public static function maybe_get_connect_url( $url = '', $data = array() ) {
+        return self::get_connect_url( false, urldecode( $data['redirect'] ) );
+    }
+
+    /**
+     * Retrieves the PayPal connect URL.
+     *
+     *
      * @param bool $is_sandbox
-	 * @param string $redirect
+     * @param string $redirect
      * @return string
-	 */
-	public static function get_connect_url( $is_sandbox, $redirect = '' ) {
+     */
+    public static function get_connect_url( $is_sandbox, $redirect = '' ) {
 
         $redirect_url = add_query_arg(
             array(
@@ -646,7 +646,7 @@ 
                 'tab'                  => 'gateways',
                 'section'              => 'paypal',
                 'getpaid-nonce'        => wp_create_nonce( 'getpaid-nonce' ),
-				'redirect'             => urlencode( $redirect ),
+                'redirect'             => urlencode( $redirect ),
             ),
             admin_url( 'admin.php' )
         );
@@ -661,12 +661,12 @@ 
 
     }
 
-	/**
-	 * Generates settings page js.
-	 *
+    /**
+     * Generates settings page js.
+     *
      * @return void
-	 */
-	public static function display_connect_buttons() {
+     */
+    public static function display_connect_buttons() {
 
         ?>
 			<div class="wpinv-paypal-connect-live">
@@ -708,70 +708,70 @@ 
         <?php
     }
 
-	/**
-	 * Connects to PayPal.
-	 *
-	 * @param array $data Connection data.
-	 * @return void
-	 */
-	public function connect_paypal( $data ) {
-
-		$sandbox      = $this->is_sandbox();
-		$data         = wp_unslash( $data );
-		$access_token = empty( $data['access_token'] ) ? '' : sanitize_text_field( $data['access_token'] );
-
-		if ( isset( $data['live_mode'] ) ) {
-			$sandbox = empty( $data['live_mode'] );
-		}
-
-		wpinv_update_option( 'paypal_sandbox', (int) $sandbox );
-		wpinv_update_option( 'paypal_active', 1 );
-
-		if ( ! empty( $data['error_description'] ) ) {
-			getpaid_admin()->show_error( wp_kses_post( urldecode( $data['error_description'] ) ) );
-		} else {
-
-			// Retrieve the user info.
-			$user_info = wp_remote_get(
-				! $sandbox ? 'https://api-m.paypal.com/v1/identity/oauth2/userinfo?schema=paypalv1.1' : 'https://api-m.sandbox.paypal.com/v1/identity/oauth2/userinfo?schema=paypalv1.1',
-				array(
-
-					'headers' => array(
-						'Authorization' => 'Bearer ' . $access_token,
-						'Content-type'  => 'application/json',
-					),
-
-				)
-			);
-
-			if ( is_wp_error( $user_info ) ) {
-				getpaid_admin()->show_error( wp_kses_post( $user_info->get_error_message() ) );
-			} else {
-
-				// Create application.
-				$user_info = json_decode( wp_remote_retrieve_body( $user_info ) );
-
-				if ( $sandbox ) {
-					wpinv_update_option( 'paypal_sandbox_email', sanitize_email( $user_info->emails[0]->value ) );
-					wpinv_update_option( 'paypal_sandbox_refresh_token', sanitize_text_field( urldecode( $data['refresh_token'] ) ) );
-					set_transient( 'getpaid_paypal_sandbox_access_token', sanitize_text_field( urldecode( $data['access_token'] ) ), (int) $data['expires_in'] );
-					getpaid_admin()->show_success( __( 'Successfully connected your PayPal sandbox account', 'invoicing' ) );
-				} else {
-					wpinv_update_option( 'paypal_email', sanitize_email( $user_info->emails[0]->value ) );
-					wpinv_update_option( 'paypal_refresh_token', sanitize_text_field( urldecode( $data['refresh_token'] ) ) );
-					set_transient( 'getpaid_paypal_access_token', sanitize_text_field( urldecode( $data['access_token'] ) ), (int) $data['expires_in'] );
-					getpaid_admin()->show_success( __( 'Successfully connected your PayPal account', 'invoicing' ) );
-				}
+    /**
+     * Connects to PayPal.
+     *
+     * @param array $data Connection data.
+     * @return void
+     */
+    public function connect_paypal( $data ) {
+
+        $sandbox      = $this->is_sandbox();
+        $data         = wp_unslash( $data );
+        $access_token = empty( $data['access_token'] ) ? '' : sanitize_text_field( $data['access_token'] );
+
+        if ( isset( $data['live_mode'] ) ) {
+            $sandbox = empty( $data['live_mode'] );
+        }
+
+        wpinv_update_option( 'paypal_sandbox', (int) $sandbox );
+        wpinv_update_option( 'paypal_active', 1 );
+
+        if ( ! empty( $data['error_description'] ) ) {
+            getpaid_admin()->show_error( wp_kses_post( urldecode( $data['error_description'] ) ) );
+        } else {
+
+            // Retrieve the user info.
+            $user_info = wp_remote_get(
+                ! $sandbox ? 'https://api-m.paypal.com/v1/identity/oauth2/userinfo?schema=paypalv1.1' : 'https://api-m.sandbox.paypal.com/v1/identity/oauth2/userinfo?schema=paypalv1.1',
+                array(
+
+                    'headers' => array(
+                        'Authorization' => 'Bearer ' . $access_token,
+                        'Content-type'  => 'application/json',
+                    ),
+
+                )
+            );
+
+            if ( is_wp_error( $user_info ) ) {
+                getpaid_admin()->show_error( wp_kses_post( $user_info->get_error_message() ) );
+            } else {
+
+                // Create application.
+                $user_info = json_decode( wp_remote_retrieve_body( $user_info ) );
+
+                if ( $sandbox ) {
+                    wpinv_update_option( 'paypal_sandbox_email', sanitize_email( $user_info->emails[0]->value ) );
+                    wpinv_update_option( 'paypal_sandbox_refresh_token', sanitize_text_field( urldecode( $data['refresh_token'] ) ) );
+                    set_transient( 'getpaid_paypal_sandbox_access_token', sanitize_text_field( urldecode( $data['access_token'] ) ), (int) $data['expires_in'] );
+                    getpaid_admin()->show_success( __( 'Successfully connected your PayPal sandbox account', 'invoicing' ) );
+                } else {
+                    wpinv_update_option( 'paypal_email', sanitize_email( $user_info->emails[0]->value ) );
+                    wpinv_update_option( 'paypal_refresh_token', sanitize_text_field( urldecode( $data['refresh_token'] ) ) );
+                    set_transient( 'getpaid_paypal_access_token', sanitize_text_field( urldecode( $data['access_token'] ) ), (int) $data['expires_in'] );
+                    getpaid_admin()->show_success( __( 'Successfully connected your PayPal account', 'invoicing' ) );
+                }
 }
 }
 
-		$redirect = empty( $data['redirect'] ) ? admin_url( 'admin.php?page=wpinv-settings&tab=gateways&section=paypal' ) : urldecode( $data['redirect'] );
+        $redirect = empty( $data['redirect'] ) ? admin_url( 'admin.php?page=wpinv-settings&tab=gateways&section=paypal' ) : urldecode( $data['redirect'] );
 
-		if ( isset( $data['step'] ) ) {
-			$redirect = add_query_arg( 'step', $data['step'], $redirect );
-		}
-		wp_redirect( $redirect );
-		exit;
-	}
+        if ( isset( $data['step'] ) ) {
+            $redirect = add_query_arg( 'step', $data['step'], $redirect );
+        }
+        wp_redirect( $redirect );
+        exit;
+    }
 
 }