AyeCode / invoicing

includes/admin/meta-boxes/class-getpaid-meta-box-invoice-address.php

Indentation +276 added lines, -276 removed lines

@@ -8,7 +8,7 @@ 
  */
 
 if ( ! defined( 'ABSPATH' ) ) {
-	exit; // Exit if accessed directly
+    exit; // Exit if accessed directly
 }
 
 /**
@@ -16,84 +16,84 @@ 
  */
 class GetPaid_Meta_Box_Invoice_Address {
 
-	/**
-	 * Output the metabox.
-	 *
-	 * @param WP_Post $post
-	 */
-	public static function output( $post ) {
-
-		// Prepare the invoice.
-		$invoice  = new WPInv_Invoice( $post );
-		$customer = $invoice->exists() ? $invoice->get_user_id( 'edit' ) : get_current_user_id();
-		$customer = new WP_User( $customer );
-		$display  = sprintf( _x( '%1$s (%2$s)', 'user dropdown', 'invoicing' ), $customer->display_name, $customer->user_email );
-		wp_nonce_field( 'getpaid_meta_nonce', 'getpaid_meta_nonce' );
-
-		// Address fields.
-		$address_fields = array(
-			'first_name' => array(
-				'label' => __( 'First Name', 'invoicing' ),
-				'type'  => 'text',
-			),
-			'last_name'  => array(
-				'label' => __( 'Last Name', 'invoicing' ),
-				'type'  => 'text',
-			),
-			'company'    => array(
-				'label' => __( 'Company', 'invoicing' ),
-				'type'  => 'text',
-				'class' => 'getpaid-recalculate-prices-on-change',
-			),
-			'vat_number' => array(
-				'label' => __( 'VAT Number', 'invoicing' ),
-				'type'  => 'text',
-			),
-			'address'    => array(
-				'label' => __( 'Address', 'invoicing' ),
-				'type'  => 'text',
-			),
-			'city'       => array(
-				'label' => __( 'City', 'invoicing' ),
-				'type'  => 'text',
-			),
-			'country'    => array(
-				'label'       => __( 'Country', 'invoicing' ),
-				'type'        => 'select',
-				'class'       => 'getpaid-recalculate-prices-on-change',
-				'options'     => wpinv_get_country_list(),
-				'placeholder' => __( 'Choose a country', 'invoicing' ),
-			),
-			'state'      => array(
-				'label' => __( 'State', 'invoicing' ),
-				'type'  => 'text',
-				'class' => 'getpaid-recalculate-prices-on-change',
-			),
-			'zip'        => array(
-				'label' => __( 'Zip', 'invoicing' ),
-				'type'  => 'text',
-			),
-			'phone'      => array(
-				'label' => __( 'Phone', 'invoicing' ),
-				'type'  => 'text',
-			),
-		);
-
-		$states = wpinv_get_country_states( $invoice->get_country( 'edit' ) );
-
-		if ( ! empty( $states ) ) {
-			$address_fields['state']['type']        = 'select';
-			$address_fields['state']['options']     = $states;
-			$address_fields['state']['placeholder'] = __( 'Choose a state', 'invoicing' );
-		}
-
-		// Maybe remove the VAT field.
-		if ( ! wpinv_use_taxes() ) {
-			unset( $address_fields['vat_number'] );
-		}
-
-		$address_fields = apply_filters( 'getpaid_admin_edit_invoice_address_fields', $address_fields, $invoice );
-		?>
+    /**
+     * Output the metabox.
+     *
+     * @param WP_Post $post
+     */
+    public static function output( $post ) {
+
+        // Prepare the invoice.
+        $invoice  = new WPInv_Invoice( $post );
+        $customer = $invoice->exists() ? $invoice->get_user_id( 'edit' ) : get_current_user_id();
+        $customer = new WP_User( $customer );
+        $display  = sprintf( _x( '%1$s (%2$s)', 'user dropdown', 'invoicing' ), $customer->display_name, $customer->user_email );
+        wp_nonce_field( 'getpaid_meta_nonce', 'getpaid_meta_nonce' );
+
+        // Address fields.
+        $address_fields = array(
+            'first_name' => array(
+                'label' => __( 'First Name', 'invoicing' ),
+                'type'  => 'text',
+            ),
+            'last_name'  => array(
+                'label' => __( 'Last Name', 'invoicing' ),
+                'type'  => 'text',
+            ),
+            'company'    => array(
+                'label' => __( 'Company', 'invoicing' ),
+                'type'  => 'text',
+                'class' => 'getpaid-recalculate-prices-on-change',
+            ),
+            'vat_number' => array(
+                'label' => __( 'VAT Number', 'invoicing' ),
+                'type'  => 'text',
+            ),
+            'address'    => array(
+                'label' => __( 'Address', 'invoicing' ),
+                'type'  => 'text',
+            ),
+            'city'       => array(
+                'label' => __( 'City', 'invoicing' ),
+                'type'  => 'text',
+            ),
+            'country'    => array(
+                'label'       => __( 'Country', 'invoicing' ),
+                'type'        => 'select',
+                'class'       => 'getpaid-recalculate-prices-on-change',
+                'options'     => wpinv_get_country_list(),
+                'placeholder' => __( 'Choose a country', 'invoicing' ),
+            ),
+            'state'      => array(
+                'label' => __( 'State', 'invoicing' ),
+                'type'  => 'text',
+                'class' => 'getpaid-recalculate-prices-on-change',
+            ),
+            'zip'        => array(
+                'label' => __( 'Zip', 'invoicing' ),
+                'type'  => 'text',
+            ),
+            'phone'      => array(
+                'label' => __( 'Phone', 'invoicing' ),
+                'type'  => 'text',
+            ),
+        );
+
+        $states = wpinv_get_country_states( $invoice->get_country( 'edit' ) );
+
+        if ( ! empty( $states ) ) {
+            $address_fields['state']['type']        = 'select';
+            $address_fields['state']['options']     = $states;
+            $address_fields['state']['placeholder'] = __( 'Choose a state', 'invoicing' );
+        }
+
+        // Maybe remove the VAT field.
+        if ( ! wpinv_use_taxes() ) {
+            unset( $address_fields['vat_number'] );
+        }
+
+        $address_fields = apply_filters( 'getpaid_admin_edit_invoice_address_fields', $address_fields, $invoice );
+        ?>
 
 		<style>
 			#wpinv-address label {
@@ -118,19 +118,19 @@ 
 							<div id="getpaid-invoice-email-wrapper" class="d-none">
 								<input type="hidden" id="getpaid-invoice-create-new-user" name="wpinv_new_user" value="" />
 								<?php
-									aui()->input(
-										array(
-											'type'        => 'text',
-											'id'          => 'getpaid-invoice-new-user-email',
-											'name'        => 'wpinv_email',
-											'label'       => __( 'Email', 'invoicing' ) . '<span class="required">*</span>',
-											'label_type'  => 'vertical',
-											'placeholder' => 'john@doe.com',
-											'class'       => 'form-control-sm',
-										),
-										true
-									);
-								?>
+                                    aui()->input(
+                                        array(
+                                            'type'        => 'text',
+                                            'id'          => 'getpaid-invoice-new-user-email',
+                                            'name'        => 'wpinv_email',
+                                            'label'       => __( 'Email', 'invoicing' ) . '<span class="required">*</span>',
+                                            'label_type'  => 'vertical',
+                                            'placeholder' => 'john@doe.com',
+                                            'class'       => 'form-control-sm',
+                                        ),
+                                        true
+                                    );
+                                ?>
 							</div>
 						</div>
 						<div class="col-12 col-sm-6 form-group mb-3 mt-sm-4">
@@ -154,39 +154,39 @@ 
 							<div class="col-12 col-sm-6 getpaid-invoice-address-field__<?php echo esc_attr( $key ); ?>--wrapper">
 								<?php
 
-									if ( 'select' === $field['type'] ) {
-										aui()->select(
-											array(
-												'id'               => 'wpinv_' . $key,
-												'name'             => 'wpinv_' . $key,
-												'label'            => $field['label'],
-												'label_type'       => 'vertical',
-												'placeholder'      => isset( $field['placeholder'] ) ? $field['placeholder'] : '',
-												'class'            => 'form-control-sm ' . ( isset( $field['class'] ) ? $field['class'] : '' ),
-												'value'            => $invoice->get( $key, 'edit' ),
-												'options'          => $field['options'],
-												'data-allow-clear' => 'false',
-												'select2'          => true,
-											),
-											true
-										);
-									} else {
-										aui()->input(
-											array(
-												'type'        => $field['type'],
-												'id'          => 'wpinv_' . $key,
-												'name'        => 'wpinv_' . $key,
-												'label'       => $field['label'],
-												'label_type'  => 'vertical',
-												'placeholder' => isset( $field['placeholder'] ) ? $field['placeholder'] : '',
-												'class'       => 'form-control-sm ' . ( isset( $field['class'] ) ? $field['class'] : '' ),
-												'value'       => $invoice->get( $key, 'edit' ),
-											),
-											true
-										);
-									}
-
-								?>
+                                    if ( 'select' === $field['type'] ) {
+                                        aui()->select(
+                                            array(
+                                                'id'               => 'wpinv_' . $key,
+                                                'name'             => 'wpinv_' . $key,
+                                                'label'            => $field['label'],
+                                                'label_type'       => 'vertical',
+                                                'placeholder'      => isset( $field['placeholder'] ) ? $field['placeholder'] : '',
+                                                'class'            => 'form-control-sm ' . ( isset( $field['class'] ) ? $field['class'] : '' ),
+                                                'value'            => $invoice->get( $key, 'edit' ),
+                                                'options'          => $field['options'],
+                                                'data-allow-clear' => 'false',
+                                                'select2'          => true,
+                                            ),
+                                            true
+                                        );
+                                    } else {
+                                        aui()->input(
+                                            array(
+                                                'type'        => $field['type'],
+                                                'id'          => 'wpinv_' . $key,
+                                                'name'        => 'wpinv_' . $key,
+                                                'label'       => $field['label'],
+                                                'label_type'  => 'vertical',
+                                                'placeholder' => isset( $field['placeholder'] ) ? $field['placeholder'] : '',
+                                                'class'       => 'form-control-sm ' . ( isset( $field['class'] ) ? $field['class'] : '' ),
+                                                'value'       => $invoice->get( $key, 'edit' ),
+                                            ),
+                                            true
+                                        );
+                                    }
+
+                                ?>
 							</div>
 						<?php endforeach; ?>
 					</div>
@@ -197,48 +197,48 @@ 
 						<div class="row">
 							<div class="col-12 col-sm-6">
 								<?php
-									aui()->select(
-										array(
-											'id'          => 'wpinv_template',
-											'name'        => 'wpinv_template',
-											'label'       => __( 'Template', 'invoicing' ),
-											'label_type'  => 'vertical',
-											'placeholder' => __( 'Choose a template', 'invoicing' ),
-											'class'       => 'form-control-sm',
-											'value'       => $invoice->get_template( 'edit' ),
-											'options'     => array(
-												'quantity' => __( 'Quantity', 'invoicing' ),
-												'hours'    => __( 'Hours', 'invoicing' ),
-											),
-											'data-allow-clear' => 'false',
-											'select2'     => true,
-										),
-										true
-									);
-								?>
+                                    aui()->select(
+                                        array(
+                                            'id'          => 'wpinv_template',
+                                            'name'        => 'wpinv_template',
+                                            'label'       => __( 'Template', 'invoicing' ),
+                                            'label_type'  => 'vertical',
+                                            'placeholder' => __( 'Choose a template', 'invoicing' ),
+                                            'class'       => 'form-control-sm',
+                                            'value'       => $invoice->get_template( 'edit' ),
+                                            'options'     => array(
+                                                'quantity' => __( 'Quantity', 'invoicing' ),
+                                                'hours'    => __( 'Hours', 'invoicing' ),
+                                            ),
+                                            'data-allow-clear' => 'false',
+                                            'select2'     => true,
+                                        ),
+                                        true
+                                    );
+                                ?>
 							</div>
 							<div class="col-12 col-sm-6">
 								<?php
 
-									// Set currency.
-									aui()->select(
-										array(
-											'id'          => 'wpinv_currency',
-											'name'        => 'wpinv_currency',
-											'label'       => __( 'Currency', 'invoicing' ),
-											'label_type'  => 'vertical',
-											'placeholder' => __( 'Select Invoice Currency', 'invoicing' ),
-											'class'       => 'form-control-sm getpaid-recalculate-prices-on-change',
-											'value'       => $invoice->get_currency( 'edit' ),
-											'required'    => false,
-											'data-allow-clear' => 'false',
-											'select2'     => true,
-											'options'     => wpinv_get_currencies(),
-										),
-										true
-									);
-
-								?>
+                                    // Set currency.
+                                    aui()->select(
+                                        array(
+                                            'id'          => 'wpinv_currency',
+                                            'name'        => 'wpinv_currency',
+                                            'label'       => __( 'Currency', 'invoicing' ),
+                                            'label_type'  => 'vertical',
+                                            'placeholder' => __( 'Select Invoice Currency', 'invoicing' ),
+                                            'class'       => 'form-control-sm getpaid-recalculate-prices-on-change',
+                                            'value'       => $invoice->get_currency( 'edit' ),
+                                            'required'    => false,
+                                            'data-allow-clear' => 'false',
+                                            'select2'     => true,
+                                            'options'     => wpinv_get_currencies(),
+                                        ),
+                                        true
+                                    );
+
+                                ?>
 							</div>
 						</div>
 
@@ -248,123 +248,123 @@ 
 					<div class="row">
 						<div class="col-12 col-sm-6">
 							<?php
-								aui()->input(
-									array(
-										'type'        => 'text',
-										'id'          => 'wpinv_company_id',
-										'name'        => 'wpinv_company_id',
-										'label'       => __( 'Company ID', 'invoicing' ),
-										'label_type'  => 'vertical',
-										'placeholder' => '',
-										'class'       => 'form-control-sm',
-										'value'       => $invoice->get_company_id( 'edit' ),
-									),
-									true
-								);
-							?>
+                                aui()->input(
+                                    array(
+                                        'type'        => 'text',
+                                        'id'          => 'wpinv_company_id',
+                                        'name'        => 'wpinv_company_id',
+                                        'label'       => __( 'Company ID', 'invoicing' ),
+                                        'label_type'  => 'vertical',
+                                        'placeholder' => '',
+                                        'class'       => 'form-control-sm',
+                                        'value'       => $invoice->get_company_id( 'edit' ),
+                                    ),
+                                    true
+                                );
+                            ?>
 						</div>
 					</div>
 
 					<?php do_action( 'getpaid_after_metabox_invoice_address', $invoice ); ?>
 			</div>
 		<?php
-	}
-
-	/**
-	 * Save meta box data.
-	 *
-	 * @param int $post_id
-	 * @param array $posted the posted data.
-	 */
-	public static function save( $post_id, $posted ) {
-
-		// Prepare the invoice.
-		$invoice = new WPInv_Invoice( $post_id );
-
-		// Load new data.
-		$invoice->set_props(
-			array(
-				'template'       => isset( $posted['wpinv_template'] ) ? wpinv_clean( $posted['wpinv_template'] ) : null,
-				'email_cc'       => isset( $posted['wpinv_cc'] ) ? wpinv_clean( $posted['wpinv_cc'] ) : null,
-				'disable_taxes'  => ! empty( $posted['disable_taxes'] ),
-				'currency'       => isset( $posted['wpinv_currency'] ) ? wpinv_clean( $posted['wpinv_currency'] ) : null,
-				'gateway'        => ( $invoice->needs_payment() && isset( $posted['wpinv_gateway'] ) ) ? wpinv_clean( $posted['wpinv_gateway'] ) : null,
-				'address'        => isset( $posted['wpinv_address'] ) ? wpinv_clean( $posted['wpinv_address'] ) : null,
-				'vat_number'     => isset( $posted['wpinv_vat_number'] ) ? wpinv_clean( $posted['wpinv_vat_number'] ) : null,
-				'company'        => isset( $posted['wpinv_company'] ) ? wpinv_clean( $posted['wpinv_company'] ) : null,
-				'company_id'     => isset( $posted['wpinv_company_id'] ) ? wpinv_clean( $posted['wpinv_company_id'] ) : null,
-				'zip'            => isset( $posted['wpinv_zip'] ) ? wpinv_clean( $posted['wpinv_zip'] ) : null,
-				'state'          => isset( $posted['wpinv_state'] ) ? wpinv_clean( $posted['wpinv_state'] ) : null,
-				'city'           => isset( $posted['wpinv_city'] ) ? wpinv_clean( $posted['wpinv_city'] ) : null,
-				'country'        => isset( $posted['wpinv_country'] ) ? wpinv_clean( $posted['wpinv_country'] ) : null,
-				'phone'          => isset( $posted['wpinv_phone'] ) ? wpinv_clean( $posted['wpinv_phone'] ) : null,
-				'first_name'     => isset( $posted['wpinv_first_name'] ) ? wpinv_clean( $posted['wpinv_first_name'] ) : null,
-				'last_name'      => isset( $posted['wpinv_last_name'] ) ? wpinv_clean( $posted['wpinv_last_name'] ) : null,
-				'author'         => isset( $posted['post_author_override'] ) ? wpinv_clean( $posted['post_author_override'] ) : null,
-				'date_created'   => isset( $posted['date_created'] ) ? wpinv_clean( $posted['date_created'] ) : null,
-				'date_completed' => isset( $posted['wpinv_date_completed'] ) ? wpinv_clean( $posted['wpinv_date_completed'] ) : null,
-				'due_date'       => isset( $posted['wpinv_due_date'] ) ? wpinv_clean( $posted['wpinv_due_date'] ) : null,
-				'number'         => isset( $posted['wpinv_number'] ) ? wpinv_clean( $posted['wpinv_number'] ) : null,
-				'status'         => isset( $posted['wpinv_status'] ) ? wpinv_clean( $posted['wpinv_status'] ) : null,
-			)
-		);
-
-		// Discount code.
-		if ( ! $invoice->is_paid() && ! $invoice->is_refunded() ) {
-
-			if ( isset( $posted['wpinv_discount_code'] ) ) {
-				$invoice->set_discount_code( wpinv_clean( $posted['wpinv_discount_code'] ) );
-			}
-
-			$discount = new WPInv_Discount( $invoice->get_discount_code() );
-			if ( $discount->exists() ) {
-				$invoice->add_discount( getpaid_calculate_invoice_discount( $invoice, $discount ) );
-			} else {
-				$invoice->remove_discount( 'discount_code' );
-			}
-
-			// Recalculate totals.
-			$invoice->recalculate_total();
-
-		}
-
-		// If we're creating a new user...
-		if ( ! empty( $posted['wpinv_new_user'] ) && is_email( stripslashes( $posted['wpinv_email'] ) ) ) {
-
-			// Attempt to create the user.
-			$user = wpinv_create_user( sanitize_email( stripslashes( $posted['wpinv_email'] ) ), $invoice->get_first_name() . $invoice->get_last_name() );
-
-			// If successful, update the invoice author.
-			if ( is_numeric( $user ) ) {
-				$invoice->set_author( $user );
-			} else {
-				wpinv_error_log( $user->get_error_message(), __( 'Invoice add new user', 'invoicing' ), __FILE__, __LINE__ );
-			}
-		}
-
-		// Do not send new invoice notifications.
-		$GLOBALS['wpinv_skip_invoice_notification'] = true;
-
-		// Save the invoice.
-		$invoice->save();
-
-		// Save the user address.
-		getpaid_save_invoice_user_address( $invoice );
-
-		// Undo do not send new invoice notifications.
-		$GLOBALS['wpinv_skip_invoice_notification'] = false;
-
-		// (Maybe) send new user notification.
-		$should_send_notification = wpinv_get_option( 'disable_new_user_emails' );
-		if ( ! empty( $user ) && is_numeric( $user ) && apply_filters( 'getpaid_send_new_user_notification', empty( $should_send_notification ) ) ) {
-			wp_send_new_user_notifications( $user, 'user' );
-		}
-
-		if ( ! empty( $posted['send_to_customer'] ) && ! $invoice->is_draft() ) {
-			getpaid()->get( 'invoice_emails' )->user_invoice( $invoice, true );
-		}
-
-		// Fires after an invoice is saved.
-		do_action( 'wpinv_invoice_metabox_saved', $invoice );
-	}
+    }
+
+    /**
+     * Save meta box data.
+     *
+     * @param int $post_id
+     * @param array $posted the posted data.
+     */
+    public static function save( $post_id, $posted ) {
+
+        // Prepare the invoice.
+        $invoice = new WPInv_Invoice( $post_id );
+
+        // Load new data.
+        $invoice->set_props(
+            array(
+                'template'       => isset( $posted['wpinv_template'] ) ? wpinv_clean( $posted['wpinv_template'] ) : null,
+                'email_cc'       => isset( $posted['wpinv_cc'] ) ? wpinv_clean( $posted['wpinv_cc'] ) : null,
+                'disable_taxes'  => ! empty( $posted['disable_taxes'] ),
+                'currency'       => isset( $posted['wpinv_currency'] ) ? wpinv_clean( $posted['wpinv_currency'] ) : null,
+                'gateway'        => ( $invoice->needs_payment() && isset( $posted['wpinv_gateway'] ) ) ? wpinv_clean( $posted['wpinv_gateway'] ) : null,
+                'address'        => isset( $posted['wpinv_address'] ) ? wpinv_clean( $posted['wpinv_address'] ) : null,
+                'vat_number'     => isset( $posted['wpinv_vat_number'] ) ? wpinv_clean( $posted['wpinv_vat_number'] ) : null,
+                'company'        => isset( $posted['wpinv_company'] ) ? wpinv_clean( $posted['wpinv_company'] ) : null,
+                'company_id'     => isset( $posted['wpinv_company_id'] ) ? wpinv_clean( $posted['wpinv_company_id'] ) : null,
+                'zip'            => isset( $posted['wpinv_zip'] ) ? wpinv_clean( $posted['wpinv_zip'] ) : null,
+                'state'          => isset( $posted['wpinv_state'] ) ? wpinv_clean( $posted['wpinv_state'] ) : null,
+                'city'           => isset( $posted['wpinv_city'] ) ? wpinv_clean( $posted['wpinv_city'] ) : null,
+                'country'        => isset( $posted['wpinv_country'] ) ? wpinv_clean( $posted['wpinv_country'] ) : null,
+                'phone'          => isset( $posted['wpinv_phone'] ) ? wpinv_clean( $posted['wpinv_phone'] ) : null,
+                'first_name'     => isset( $posted['wpinv_first_name'] ) ? wpinv_clean( $posted['wpinv_first_name'] ) : null,
+                'last_name'      => isset( $posted['wpinv_last_name'] ) ? wpinv_clean( $posted['wpinv_last_name'] ) : null,
+                'author'         => isset( $posted['post_author_override'] ) ? wpinv_clean( $posted['post_author_override'] ) : null,
+                'date_created'   => isset( $posted['date_created'] ) ? wpinv_clean( $posted['date_created'] ) : null,
+                'date_completed' => isset( $posted['wpinv_date_completed'] ) ? wpinv_clean( $posted['wpinv_date_completed'] ) : null,
+                'due_date'       => isset( $posted['wpinv_due_date'] ) ? wpinv_clean( $posted['wpinv_due_date'] ) : null,
+                'number'         => isset( $posted['wpinv_number'] ) ? wpinv_clean( $posted['wpinv_number'] ) : null,
+                'status'         => isset( $posted['wpinv_status'] ) ? wpinv_clean( $posted['wpinv_status'] ) : null,
+            )
+        );
+
+        // Discount code.
+        if ( ! $invoice->is_paid() && ! $invoice->is_refunded() ) {
+
+            if ( isset( $posted['wpinv_discount_code'] ) ) {
+                $invoice->set_discount_code( wpinv_clean( $posted['wpinv_discount_code'] ) );
+            }
+
+            $discount = new WPInv_Discount( $invoice->get_discount_code() );
+            if ( $discount->exists() ) {
+                $invoice->add_discount( getpaid_calculate_invoice_discount( $invoice, $discount ) );
+            } else {
+                $invoice->remove_discount( 'discount_code' );
+            }
+
+            // Recalculate totals.
+            $invoice->recalculate_total();
+
+        }
+
+        // If we're creating a new user...
+        if ( ! empty( $posted['wpinv_new_user'] ) && is_email( stripslashes( $posted['wpinv_email'] ) ) ) {
+
+            // Attempt to create the user.
+            $user = wpinv_create_user( sanitize_email( stripslashes( $posted['wpinv_email'] ) ), $invoice->get_first_name() . $invoice->get_last_name() );
+
+            // If successful, update the invoice author.
+            if ( is_numeric( $user ) ) {
+                $invoice->set_author( $user );
+            } else {
+                wpinv_error_log( $user->get_error_message(), __( 'Invoice add new user', 'invoicing' ), __FILE__, __LINE__ );
+            }
+        }
+
+        // Do not send new invoice notifications.
+        $GLOBALS['wpinv_skip_invoice_notification'] = true;
+
+        // Save the invoice.
+        $invoice->save();
+
+        // Save the user address.
+        getpaid_save_invoice_user_address( $invoice );
+
+        // Undo do not send new invoice notifications.
+        $GLOBALS['wpinv_skip_invoice_notification'] = false;
+
+        // (Maybe) send new user notification.
+        $should_send_notification = wpinv_get_option( 'disable_new_user_emails' );
+        if ( ! empty( $user ) && is_numeric( $user ) && apply_filters( 'getpaid_send_new_user_notification', empty( $should_send_notification ) ) ) {
+            wp_send_new_user_notifications( $user, 'user' );
+        }
+
+        if ( ! empty( $posted['send_to_customer'] ) && ! $invoice->is_draft() ) {
+            getpaid()->get( 'invoice_emails' )->user_invoice( $invoice, true );
+        }
+
+        // Fires after an invoice is saved.
+        do_action( 'wpinv_invoice_metabox_saved', $invoice );
+    }
 }

includes/payments/class-getpaid-checkout.php

Indentation +309 added lines, -309 removed lines

@@ -12,184 +12,184 @@ 
  */
 class GetPaid_Checkout {
 
-	/**
-	 * @var GetPaid_Payment_Form_Submission
-	 */
-	protected $payment_form_submission;
-
-	/**
-	 * Class constructor.
-	 *
-	 * @param GetPaid_Payment_Form_Submission $submission
-	 */
-	public function __construct( $submission ) {
-		$this->payment_form_submission = $submission;
-	}
-
-	/**
-	 * Processes the checkout.
-	 *
-	 */
-	public function process_checkout() {
-
-		// Validate the submission.
-		$this->validate_submission();
-
-		// Prepare the invoice.
-		$items      = $this->get_submission_items();
-		$invoice    = $this->get_submission_invoice();
-		$invoice    = $this->process_submission_invoice( $invoice, $items );
-		$prepared   = $this->prepare_submission_data_for_saving();
-
-		$this->prepare_billing_info( $invoice );
-
-		$shipping   = $this->prepare_shipping_info( $invoice );
-
-		// Save the invoice.
-		$invoice->set_is_viewed( true );
-		$invoice->recalculate_total();
+    /**
+     * @var GetPaid_Payment_Form_Submission
+     */
+    protected $payment_form_submission;
+
+    /**
+     * Class constructor.
+     *
+     * @param GetPaid_Payment_Form_Submission $submission
+     */
+    public function __construct( $submission ) {
+        $this->payment_form_submission = $submission;
+    }
+
+    /**
+     * Processes the checkout.
+     *
+     */
+    public function process_checkout() {
+
+        // Validate the submission.
+        $this->validate_submission();
+
+        // Prepare the invoice.
+        $items      = $this->get_submission_items();
+        $invoice    = $this->get_submission_invoice();
+        $invoice    = $this->process_submission_invoice( $invoice, $items );
+        $prepared   = $this->prepare_submission_data_for_saving();
+
+        $this->prepare_billing_info( $invoice );
+
+        $shipping   = $this->prepare_shipping_info( $invoice );
+
+        // Save the invoice.
+        $invoice->set_is_viewed( true );
+        $invoice->recalculate_total();
         $invoice->save();
 
-		do_action( 'getpaid_checkout_invoice_updated', $invoice );
+        do_action( 'getpaid_checkout_invoice_updated', $invoice );
 
-		// Send to the gateway.
-		$this->post_process_submission( $invoice, $prepared, $shipping );
-	}
+        // Send to the gateway.
+        $this->post_process_submission( $invoice, $prepared, $shipping );
+    }
 
-	/**
-	 * Validates the submission.
-	 *
-	 */
-	protected function validate_submission() {
+    /**
+     * Validates the submission.
+     *
+     */
+    protected function validate_submission() {
 
-		$submission = $this->payment_form_submission;
-		$data       = $submission->get_data();
+        $submission = $this->payment_form_submission;
+        $data       = $submission->get_data();
 
-		// Do we have an error?
+        // Do we have an error?
         if ( ! empty( $submission->last_error ) ) {
-			wp_send_json_error( $submission->last_error );
+            wp_send_json_error( $submission->last_error );
         }
 
-		// We need a billing email.
+        // We need a billing email.
         if ( ! $submission->has_billing_email() ) {
             wp_send_json_error( __( 'Provide a valid billing email.', 'invoicing' ) );
-		}
+        }
 
-		// Non-recurring gateways should not be allowed to process recurring invoices.
-		if ( $submission->should_collect_payment_details() && $submission->has_recurring && ! wpinv_gateway_support_subscription( $data['wpi-gateway'] ) ) {
-			wp_send_json_error( __( 'The selected payment gateway does not support subscription payments.', 'invoicing' ) );
-		}
+        // Non-recurring gateways should not be allowed to process recurring invoices.
+        if ( $submission->should_collect_payment_details() && $submission->has_recurring && ! wpinv_gateway_support_subscription( $data['wpi-gateway'] ) ) {
+            wp_send_json_error( __( 'The selected payment gateway does not support subscription payments.', 'invoicing' ) );
+        }
 
-		// Ensure the gateway is active.
-		if ( $submission->should_collect_payment_details() && ! wpinv_is_gateway_active( $data['wpi-gateway'] ) ) {
-			wp_send_json_error( __( 'The selected payment gateway is not active', 'invoicing' ) );
-		}
+        // Ensure the gateway is active.
+        if ( $submission->should_collect_payment_details() && ! wpinv_is_gateway_active( $data['wpi-gateway'] ) ) {
+            wp_send_json_error( __( 'The selected payment gateway is not active', 'invoicing' ) );
+        }
 
-		// Clear any existing errors.
-		wpinv_clear_errors();
+        // Clear any existing errors.
+        wpinv_clear_errors();
 
-		// Allow themes and plugins to hook to errors
-		do_action( 'getpaid_checkout_error_checks', $submission );
+        // Allow themes and plugins to hook to errors
+        do_action( 'getpaid_checkout_error_checks', $submission );
 
-		// Do we have any errors?
+        // Do we have any errors?
         if ( wpinv_get_errors() ) {
             wp_send_json_error( getpaid_get_errors_html() );
-		}
+        }
 
-	}
+    }
 
-	/**
-	 * Retrieves submission items.
-	 *
-	 * @return GetPaid_Form_Item[]
-	 */
-	protected function get_submission_items() {
+    /**
+     * Retrieves submission items.
+     *
+     * @return GetPaid_Form_Item[]
+     */
+    protected function get_submission_items() {
 
-		$items = $this->payment_form_submission->get_items();
+        $items = $this->payment_form_submission->get_items();
 
         // Ensure that we have items.
         if ( empty( $items ) && ! $this->payment_form_submission->has_fees() ) {
             wp_send_json_error( __( 'Please provide at least one item or amount.', 'invoicing' ) );
-		}
-
-		return $items;
-	}
-
-	/**
-	 * Retrieves submission invoice.
-	 *
-	 * @return WPInv_Invoice
-	 */
-	protected function get_submission_invoice() {
-		$submission = $this->payment_form_submission;
-
-		if ( ! $submission->has_invoice() ) {
-			$invoice = new WPInv_Invoice();
-			$invoice->set_created_via( 'payment_form' );
-			return $invoice;
         }
 
-		$invoice = $submission->get_invoice();
+        return $items;
+    }
+
+    /**
+     * Retrieves submission invoice.
+     *
+     * @return WPInv_Invoice
+     */
+    protected function get_submission_invoice() {
+        $submission = $this->payment_form_submission;
 
-		// Make sure that it is neither paid or refunded.
-		if ( $invoice->is_paid() || $invoice->is_refunded() ) {
-			wp_send_json_error( __( 'This invoice has already been paid for.', 'invoicing' ) );
-		}
+        if ( ! $submission->has_invoice() ) {
+            $invoice = new WPInv_Invoice();
+            $invoice->set_created_via( 'payment_form' );
+            return $invoice;
+        }
 
-		return $invoice;
-	}
+        $invoice = $submission->get_invoice();
 
-	/**
-	 * Processes the submission invoice.
-	 *
-	 * @param WPInv_Invoice $invoice
-	 * @param GetPaid_Form_Item[] $items
-	 * @return WPInv_Invoice
-	 */
-	protected function process_submission_invoice( $invoice, $items ) {
+        // Make sure that it is neither paid or refunded.
+        if ( $invoice->is_paid() || $invoice->is_refunded() ) {
+            wp_send_json_error( __( 'This invoice has already been paid for.', 'invoicing' ) );
+        }
 
-		$submission = $this->payment_form_submission;
+        return $invoice;
+    }
 
-		// Set-up the invoice details.
-		$invoice->set_email( sanitize_email( $submission->get_billing_email() ) );
-		$invoice->set_user_id( $this->get_submission_customer() );
-		$invoice->set_payment_form( absint( $submission->get_payment_form()->get_id() ) );
+    /**
+     * Processes the submission invoice.
+     *
+     * @param WPInv_Invoice $invoice
+     * @param GetPaid_Form_Item[] $items
+     * @return WPInv_Invoice
+     */
+    protected function process_submission_invoice( $invoice, $items ) {
+
+        $submission = $this->payment_form_submission;
+
+        // Set-up the invoice details.
+        $invoice->set_email( sanitize_email( $submission->get_billing_email() ) );
+        $invoice->set_user_id( $this->get_submission_customer() );
+        $invoice->set_payment_form( absint( $submission->get_payment_form()->get_id() ) );
         $invoice->set_items( $items );
         $invoice->set_fees( $submission->get_fees() );
         $invoice->set_taxes( $submission->get_taxes() );
-		$invoice->set_discounts( $submission->get_discounts() );
-		$invoice->set_gateway( $submission->get_field( 'wpi-gateway' ) );
-		$invoice->set_currency( $submission->get_currency() );
+        $invoice->set_discounts( $submission->get_discounts() );
+        $invoice->set_gateway( $submission->get_field( 'wpi-gateway' ) );
+        $invoice->set_currency( $submission->get_currency() );
 
-		if ( $submission->has_shipping() ) {
-			$invoice->set_shipping( $submission->get_shipping() );
-		}
+        if ( $submission->has_shipping() ) {
+            $invoice->set_shipping( $submission->get_shipping() );
+        }
 
-		$address_confirmed = $submission->get_field( 'confirm-address' );
-		$invoice->set_address_confirmed( ! empty( $address_confirmed ) );
+        $address_confirmed = $submission->get_field( 'confirm-address' );
+        $invoice->set_address_confirmed( ! empty( $address_confirmed ) );
 
-		if ( $submission->has_discount_code() ) {
+        if ( $submission->has_discount_code() ) {
             $invoice->set_discount_code( $submission->get_discount_code() );
-		}
-
-		getpaid_maybe_add_default_address( $invoice );
-		return $invoice;
-	}
-
-	/**
-	 * Retrieves the submission's customer.
-	 *
-	 * @return int The customer id.
-	 */
-	protected function get_submission_customer() {
-		$submission = $this->payment_form_submission;
-
-		// If this is an existing invoice...
-		if ( $submission->has_invoice() ) {
-			return $submission->get_invoice()->get_user_id();
-		}
-
-		// (Maybe) create the user.
+        }
+
+        getpaid_maybe_add_default_address( $invoice );
+        return $invoice;
+    }
+
+    /**
+     * Retrieves the submission's customer.
+     *
+     * @return int The customer id.
+     */
+    protected function get_submission_customer() {
+        $submission = $this->payment_form_submission;
+
+        // If this is an existing invoice...
+        if ( $submission->has_invoice() ) {
+            return $submission->get_invoice()->get_user_id();
+        }
+
+        // (Maybe) create the user.
         $user = get_current_user_id();
 
         if ( empty( $user ) ) {
@@ -197,16 +197,16 @@ 
         }
 
         if ( empty( $user ) ) {
-			$name = array( $submission->get_field( 'wpinv_first_name', 'billing' ), $submission->get_field( 'wpinv_last_name', 'billing' ) );
-			$name = implode( '', array_filter( $name ) );
+            $name = array( $submission->get_field( 'wpinv_first_name', 'billing' ), $submission->get_field( 'wpinv_last_name', 'billing' ) );
+            $name = implode( '', array_filter( $name ) );
             $user = wpinv_create_user( $submission->get_billing_email(), $name );
 
-			// (Maybe) send new user notification.
-			$should_send_notification = wpinv_get_option( 'disable_new_user_emails' );
-			if ( ! empty( $user ) && is_numeric( $user ) && apply_filters( 'getpaid_send_new_user_notification', empty( $should_send_notification ), $user ) ) {
-				wp_send_new_user_notifications( $user, 'user' );
-			}
-		}
+            // (Maybe) send new user notification.
+            $should_send_notification = wpinv_get_option( 'disable_new_user_emails' );
+            if ( ! empty( $user ) && is_numeric( $user ) && apply_filters( 'getpaid_send_new_user_notification', empty( $should_send_notification ), $user ) ) {
+                wp_send_new_user_notifications( $user, 'user' );
+            }
+        }
 
         if ( is_wp_error( $user ) ) {
             wp_send_json_error( $user->get_error_message() );
@@ -214,49 +214,49 @@ 
 
         if ( is_numeric( $user ) ) {
             return $user;
-		}
+        }
 
-		return $user->ID;
+        return $user->ID;
 
-	}
+    }
 
-	/**
+    /**
      * Prepares submission data for saving to the database.
      *
-	 * @return array
+     * @return array
      */
     public function prepare_submission_data_for_saving() {
 
-		$submission = $this->payment_form_submission;
+        $submission = $this->payment_form_submission;
 
-		// Prepared submission details.
+        // Prepared submission details.
         $prepared = array(
-			'all'  => array(),
-			'meta' => array(),
-		);
+            'all'  => array(),
+            'meta' => array(),
+        );
 
         // Raw submission details.
-		$data     = $submission->get_data();
+        $data     = $submission->get_data();
 
-		// Loop through the submitted details.
+        // Loop through the submitted details.
         foreach ( $submission->get_payment_form()->get_elements() as $field ) {
 
-			// Skip premade fields.
+            // Skip premade fields.
             if ( ! empty( $field['premade'] ) ) {
                 continue;
             }
 
-			// Ensure address is provided.
-			if ( 'address' === $field['type'] ) {
+            // Ensure address is provided.
+            if ( 'address' === $field['type'] ) {
                 $address_type = isset( $field['address_type'] ) && 'shipping' === $field['address_type'] ? 'shipping' : 'billing';
 
-				foreach ( $field['fields'] as $address_field ) {
+                foreach ( $field['fields'] as $address_field ) {
 
-					if ( ! empty( $address_field['visible'] ) && ! empty( $address_field['required'] ) && '' === trim( $_POST[ $address_type ][ $address_field['name'] ] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Missing
-						wp_send_json_error( __( 'Please fill all required fields.', 'invoicing' ) );
-					}
-			}
-		}
+                    if ( ! empty( $address_field['visible'] ) && ! empty( $address_field['required'] ) && '' === trim( $_POST[ $address_type ][ $address_field['name'] ] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Missing
+                        wp_send_json_error( __( 'Please fill all required fields.', 'invoicing' ) );
+                    }
+            }
+        }
 
             // If it is required and not set, abort.
             if ( ! $submission->is_required_field_set( $field ) ) {
@@ -266,31 +266,31 @@ 
             // Handle misc fields.
             if ( isset( $data[ $field['id'] ] ) ) {
 
-				// Uploads.
-				if ( 'file_upload' === $field['type'] ) {
-					$max_file_num = empty( $field['max_file_num'] ) ? 1 : absint( $field['max_file_num'] );
+                // Uploads.
+                if ( 'file_upload' === $field['type'] ) {
+                    $max_file_num = empty( $field['max_file_num'] ) ? 1 : absint( $field['max_file_num'] );
 
-					if ( count( $data[ $field['id'] ] ) > $max_file_num ) {
-						wp_send_json_error( __( 'Maximum number of allowed files exceeded.', 'invoicing' ) );
-					}
+                    if ( count( $data[ $field['id'] ] ) > $max_file_num ) {
+                        wp_send_json_error( __( 'Maximum number of allowed files exceeded.', 'invoicing' ) );
+                    }
 
-					$value = array();
+                    $value = array();
 
-					foreach ( $data[ $field['id'] ] as $url => $name ) {
-						$value[] = sprintf(
-							'<a href="%s" target="_blank">%s</a>',
-							esc_url_raw( $url ),
-							esc_html( $name )
-						);
-					}
+                    foreach ( $data[ $field['id'] ] as $url => $name ) {
+                        $value[] = sprintf(
+                            '<a href="%s" target="_blank">%s</a>',
+                            esc_url_raw( $url ),
+                            esc_html( $name )
+                        );
+                    }
 
-					$value = implode( ' | ', $value );
+                    $value = implode( ' | ', $value );
 
-				} elseif ( 'checkbox' === $field['type'] ) {
-					$value = ! empty( $data[ $field['id'] ] ) ? __( 'Yes', 'invoicing' ) : __( 'No', 'invoicing' );
-				} else {
-					$value = wp_kses_post( $data[ $field['id'] ] );
-				}
+                } elseif ( 'checkbox' === $field['type'] ) {
+                    $value = ! empty( $data[ $field['id'] ] ) ? __( 'Yes', 'invoicing' ) : __( 'No', 'invoicing' );
+                } else {
+                    $value = wp_kses_post( $data[ $field['id'] ] );
+                }
 
                 $label = $field['id'];
 
@@ -298,192 +298,192 @@ 
                     $label = $field['label'];
                 }
 
-				if ( ! empty( $field['add_meta'] ) ) {
-					$prepared['meta'][ wpinv_clean( $label ) ] = wp_kses_post_deep( $value );
-				}
-				$prepared['all'][ wpinv_clean( $label ) ] = wp_kses_post_deep( $value );
+                if ( ! empty( $field['add_meta'] ) ) {
+                    $prepared['meta'][ wpinv_clean( $label ) ] = wp_kses_post_deep( $value );
+                }
+                $prepared['all'][ wpinv_clean( $label ) ] = wp_kses_post_deep( $value );
 
             }
-		}
+        }
 
-		return $prepared;
+        return $prepared;
 
-	}
+    }
 
-	/**
+    /**
      * Retrieves address details.
      *
-	 * @return array
-	 * @param WPInv_Invoice $invoice
-	 * @param string $type
+     * @return array
+     * @param WPInv_Invoice $invoice
+     * @param string $type
      */
     public function prepare_address_details( $invoice, $type = 'billing' ) {
 
-		$data     = $this->payment_form_submission->get_data();
-		$type     = sanitize_key( $type );
-		$address  = array();
-		$prepared = array();
+        $data     = $this->payment_form_submission->get_data();
+        $type     = sanitize_key( $type );
+        $address  = array();
+        $prepared = array();
 
-		if ( ! empty( $data[ $type ] ) ) {
-			$address = $data[ $type ];
-		}
+        if ( ! empty( $data[ $type ] ) ) {
+            $address = $data[ $type ];
+        }
 
-		// Clean address details.
-		foreach ( $address as $key => $value ) {
-			$key             = sanitize_key( $key );
-			$key             = str_replace( 'wpinv_', '', $key );
-			$value           = wpinv_clean( $value );
-			$prepared[ $key ] = apply_filters( "getpaid_checkout_{$type}_address_$key", $value, $this->payment_form_submission, $invoice );
-		}
+        // Clean address details.
+        foreach ( $address as $key => $value ) {
+            $key             = sanitize_key( $key );
+            $key             = str_replace( 'wpinv_', '', $key );
+            $value           = wpinv_clean( $value );
+            $prepared[ $key ] = apply_filters( "getpaid_checkout_{$type}_address_$key", $value, $this->payment_form_submission, $invoice );
+        }
 
-		// Filter address details.
-		$prepared = apply_filters( "getpaid_checkout_{$type}_address", $prepared, $this->payment_form_submission, $invoice );
+        // Filter address details.
+        $prepared = apply_filters( "getpaid_checkout_{$type}_address", $prepared, $this->payment_form_submission, $invoice );
 
-		// Remove non-whitelisted values.
-		return array_filter( $prepared, 'getpaid_is_address_field_whitelisted', ARRAY_FILTER_USE_KEY );
+        // Remove non-whitelisted values.
+        return array_filter( $prepared, 'getpaid_is_address_field_whitelisted', ARRAY_FILTER_USE_KEY );
 
-	}
+    }
 
-	/**
+    /**
      * Prepares the billing details.
      *
-	 * @return array
-	 * @param WPInv_Invoice $invoice
+     * @return array
+     * @param WPInv_Invoice $invoice
      */
     protected function prepare_billing_info( &$invoice ) {
 
-		$billing_address = $this->prepare_address_details( $invoice, 'billing' );
+        $billing_address = $this->prepare_address_details( $invoice, 'billing' );
 
-		// Update the invoice with the billing details.
-		$invoice->set_props( $billing_address );
+        // Update the invoice with the billing details.
+        $invoice->set_props( $billing_address );
 
-	}
+    }
 
-	/**
+    /**
      * Prepares the shipping details.
      *
-	 * @return array
-	 * @param WPInv_Invoice $invoice
+     * @return array
+     * @param WPInv_Invoice $invoice
      */
     protected function prepare_shipping_info( $invoice ) {
 
-		$data = $this->payment_form_submission->get_data();
+        $data = $this->payment_form_submission->get_data();
 
-		if ( empty( $data['same-shipping-address'] ) ) {
-			return $this->prepare_address_details( $invoice, 'shipping' );
-		}
+        if ( empty( $data['same-shipping-address'] ) ) {
+            return $this->prepare_address_details( $invoice, 'shipping' );
+        }
 
-		return $this->prepare_address_details( $invoice, 'billing' );
+        return $this->prepare_address_details( $invoice, 'billing' );
 
-	}
+    }
 
-	/**
-	 * Confirms the submission is valid and send users to the gateway.
-	 *
-	 * @param WPInv_Invoice $invoice
-	 * @param array $prepared_payment_form_data
-	 * @param array $shipping
-	 */
-	protected function post_process_submission( $invoice, $prepared_payment_form_data, $shipping ) {
+    /**
+     * Confirms the submission is valid and send users to the gateway.
+     *
+     * @param WPInv_Invoice $invoice
+     * @param array $prepared_payment_form_data
+     * @param array $shipping
+     */
+    protected function post_process_submission( $invoice, $prepared_payment_form_data, $shipping ) {
 
-		// Ensure the invoice exists.
+        // Ensure the invoice exists.
         if ( ! $invoice->exists() ) {
             wp_send_json_error( __( 'An error occured while saving your invoice. Please try again.', 'invoicing' ) );
         }
 
-		// Save payment form data.
-		$prepared_payment_form_data = apply_filters( 'getpaid_prepared_payment_form_data', $prepared_payment_form_data, $invoice );
+        // Save payment form data.
+        $prepared_payment_form_data = apply_filters( 'getpaid_prepared_payment_form_data', $prepared_payment_form_data, $invoice );
         delete_post_meta( $invoice->get_id(), 'payment_form_data' );
-		delete_post_meta( $invoice->get_id(), 'additional_meta_data' );
-		if ( ! empty( $prepared_payment_form_data ) ) {
+        delete_post_meta( $invoice->get_id(), 'additional_meta_data' );
+        if ( ! empty( $prepared_payment_form_data ) ) {
 
-			if ( ! empty( $prepared_payment_form_data['all'] ) ) {
-				update_post_meta( $invoice->get_id(), 'payment_form_data', $prepared_payment_form_data['all'] );
-			}
+            if ( ! empty( $prepared_payment_form_data['all'] ) ) {
+                update_post_meta( $invoice->get_id(), 'payment_form_data', $prepared_payment_form_data['all'] );
+            }
 
-			if ( ! empty( $prepared_payment_form_data['meta'] ) ) {
-				update_post_meta( $invoice->get_id(), 'additional_meta_data', $prepared_payment_form_data['meta'] );
-			}
-		}
+            if ( ! empty( $prepared_payment_form_data['meta'] ) ) {
+                update_post_meta( $invoice->get_id(), 'additional_meta_data', $prepared_payment_form_data['meta'] );
+            }
+        }
 
-		// Save payment form data.
-		$shipping = apply_filters( 'getpaid_checkout_shipping_details', $shipping, $this->payment_form_submission );
+        // Save payment form data.
+        $shipping = apply_filters( 'getpaid_checkout_shipping_details', $shipping, $this->payment_form_submission );
         if ( ! empty( $shipping ) ) {
             update_post_meta( $invoice->get_id(), 'shipping_address', $shipping );
-		}
+        }
 
-		// Backwards compatibility.
+        // Backwards compatibility.
         add_filter( 'wp_redirect', array( $this, 'send_redirect_response' ) );
 
-		try {
-			$this->process_payment( $invoice );
-		} catch ( Exception $e ) {
-			wpinv_set_error( 'payment_error', $e->getMessage() );
-		}
+        try {
+            $this->process_payment( $invoice );
+        } catch ( Exception $e ) {
+            wpinv_set_error( 'payment_error', $e->getMessage() );
+        }
 
         // If we are here, there was an error.
-		wpinv_send_back_to_checkout( $invoice );
+        wpinv_send_back_to_checkout( $invoice );
 
-	}
+    }
 
-	/**
-	 * Processes the actual payment.
-	 *
-	 * @param WPInv_Invoice $invoice
-	 */
-	protected function process_payment( $invoice ) {
+    /**
+     * Processes the actual payment.
+     *
+     * @param WPInv_Invoice $invoice
+     */
+    protected function process_payment( $invoice ) {
 
-		// Clear any checkout errors.
-		wpinv_clear_errors();
+        // Clear any checkout errors.
+        wpinv_clear_errors();
 
-		// No need to send free invoices to the gateway.
-		if ( $invoice->is_free() ) {
-			$this->process_free_payment( $invoice );
-		}
+        // No need to send free invoices to the gateway.
+        if ( $invoice->is_free() ) {
+            $this->process_free_payment( $invoice );
+        }
 
-		$submission = $this->payment_form_submission;
+        $submission = $this->payment_form_submission;
 
-		// Fires before sending to the gateway.
-		do_action( 'getpaid_checkout_before_gateway', $invoice, $submission );
+        // Fires before sending to the gateway.
+        do_action( 'getpaid_checkout_before_gateway', $invoice, $submission );
 
-		// Allow the sumission data to be modified before it is sent to the gateway.
-		$submission_data    = $submission->get_data();
-		$submission_gateway = apply_filters( 'getpaid_gateway_submission_gateway', $invoice->get_gateway(), $submission, $invoice );
-		$submission_data    = apply_filters( 'getpaid_gateway_submission_data', $submission_data, $submission, $invoice );
+        // Allow the sumission data to be modified before it is sent to the gateway.
+        $submission_data    = $submission->get_data();
+        $submission_gateway = apply_filters( 'getpaid_gateway_submission_gateway', $invoice->get_gateway(), $submission, $invoice );
+        $submission_data    = apply_filters( 'getpaid_gateway_submission_data', $submission_data, $submission, $invoice );
 
-		// Validate the currency.
-		if ( ! apply_filters( "getpaid_gateway_{$submission_gateway}_is_valid_for_currency", true, $invoice->get_currency() ) ) {
-			wpinv_set_error( 'invalid_currency' );
-		}
+        // Validate the currency.
+        if ( ! apply_filters( "getpaid_gateway_{$submission_gateway}_is_valid_for_currency", true, $invoice->get_currency() ) ) {
+            wpinv_set_error( 'invalid_currency' );
+        }
 
-		// Check to see if we have any errors.
-		if ( wpinv_get_errors() ) {
-			wpinv_send_back_to_checkout( $invoice );
-		}
+        // Check to see if we have any errors.
+        if ( wpinv_get_errors() ) {
+            wpinv_send_back_to_checkout( $invoice );
+        }
 
-		// Send info to the gateway for payment processing
-		do_action( "getpaid_gateway_$submission_gateway", $invoice, $submission_data, $submission );
+        // Send info to the gateway for payment processing
+        do_action( "getpaid_gateway_$submission_gateway", $invoice, $submission_data, $submission );
 
-		// Backwards compatibility.
-		wpinv_send_to_gateway( $submission_gateway, $invoice );
+        // Backwards compatibility.
+        wpinv_send_to_gateway( $submission_gateway, $invoice );
 
-	}
+    }
 
-	/**
-	 * Marks the invoice as paid in case the checkout is free.
-	 *
-	 * @param WPInv_Invoice $invoice
-	 */
-	protected function process_free_payment( $invoice ) {
+    /**
+     * Marks the invoice as paid in case the checkout is free.
+     *
+     * @param WPInv_Invoice $invoice
+     */
+    protected function process_free_payment( $invoice ) {
 
-		$invoice->set_gateway( 'none' );
-		$invoice->add_note( __( "This is a free invoice and won't be sent to the payment gateway", 'invoicing' ), false, false, true );
-		$invoice->mark_paid();
-		wpinv_send_to_success_page( array( 'invoice_key' => $invoice->get_key() ) );
+        $invoice->set_gateway( 'none' );
+        $invoice->add_note( __( "This is a free invoice and won't be sent to the payment gateway", 'invoicing' ), false, false, true );
+        $invoice->mark_paid();
+        wpinv_send_to_success_page( array( 'invoice_key' => $invoice->get_key() ) );
 
-	}
+    }
 
-	/**
+    /**
      * Sends a redrect response to payment details.
      *
      */

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

Indentation +878 added lines, -878 removed lines

@@ -1,6 +1,6 @@ 
 <?php
 if ( ! defined( 'ABSPATH' ) ) {
-	exit;
+    exit;
 }
 
 /**
@@ -10,199 +10,199 @@ 
 class GetPaid_Payment_Form_Submission {
 
     /**
-	 * Submission ID
-	 *
-	 * @var string
-	 */
-	public $id = null;
-
-	/**
-	 * The raw submission data.
-	 *
-	 * @var array
-	 */
-	protected $data = null;
-
-	/**
-	 * Submission totals
-	 *
-	 * @var array
-	 */
-	protected $totals = array(
-
-		'subtotal' => array(
-			'initial'   => 0,
-			'recurring' => 0,
-		),
-
-		'discount' => array(
-			'initial'   => 0,
-			'recurring' => 0,
-		),
-
-		'fees'     => array(
-			'initial'   => 0,
-			'recurring' => 0,
-		),
-
-		'taxes'    => array(
-			'initial'   => 0,
-			'recurring' => 0,
-		),
-
-		'shipping' => array(
-			'initial'   => 0,
-			'recurring' => 0,
-		),
-
-	);
-
-	/**
-	 * Sets the associated payment form.
-	 *
-	 * @var GetPaid_Payment_Form
-	 */
+     * Submission ID
+     *
+     * @var string
+     */
+    public $id = null;
+
+    /**
+     * The raw submission data.
+     *
+     * @var array
+     */
+    protected $data = null;
+
+    /**
+     * Submission totals
+     *
+     * @var array
+     */
+    protected $totals = array(
+
+        'subtotal' => array(
+            'initial'   => 0,
+            'recurring' => 0,
+        ),
+
+        'discount' => array(
+            'initial'   => 0,
+            'recurring' => 0,
+        ),
+
+        'fees'     => array(
+            'initial'   => 0,
+            'recurring' => 0,
+        ),
+
+        'taxes'    => array(
+            'initial'   => 0,
+            'recurring' => 0,
+        ),
+
+        'shipping' => array(
+            'initial'   => 0,
+            'recurring' => 0,
+        ),
+
+    );
+
+    /**
+     * Sets the associated payment form.
+     *
+     * @var GetPaid_Payment_Form
+     */
     protected $payment_form = null;
 
     /**
-	 * The country for the submission.
-	 *
-	 * @var string
-	 */
-	public $country = null;
-
-    /**
-	 * The state for the submission.
-	 *
-	 * @since 1.0.19
-	 * @var string
-	 */
-	public $state = null;
-
-	/**
-	 * The invoice associated with the submission.
-	 *
-	 * @var WPInv_Invoice
-	 */
-	protected $invoice = null;
-
-	/**
-	 * The recurring item for the submission.
-	 *
-	 * @var int
-	 */
-	public $has_recurring = 0;
-
-	/**
-	 * An array of fees for the submission.
-	 *
-	 * @var array
-	 */
-	protected $fees = array();
-
-	/**
-	 * An array of discounts for the submission.
-	 *
-	 * @var array
-	 */
-	protected $discounts = array();
-
-	/**
-	 * An array of taxes for the submission.
-	 *
-	 * @var array
-	 */
-	protected $taxes = array();
-
-	/**
-	 * An array of items for the submission.
-	 *
-	 * @var GetPaid_Form_Item[]
-	 */
-	protected $items = array();
-
-	/**
-	 * The last error.
-	 *
-	 * @var string
-	 */
-	public $last_error = null;
-
-	/**
-	 * The last error code.
-	 *
-	 * @var string
-	 */
-	public $last_error_code = null;
-
-    /**
-	 * Class constructor.
-	 *
-	 */
-	public function __construct() {
-
-		// Set the state and country to the default state and country.
-		$this->country = wpinv_default_billing_country();
-		$this->state   = wpinv_get_default_state();
-
-		// Do we have an actual submission?
-		if ( isset( $_POST['getpaid_payment_form_submission'] ) ) {
-			$this->load_data( wp_kses_post_deep( wp_unslash( $_POST ) ) );
-		}
-
-	}
-
-	/**
-	 * Loads submission data.
-	 *
-	 * @param array $data
-	 */
-	public function load_data( $data ) {
-
-		// Allow plugins to filter the data.
-		$data       = apply_filters( 'getpaid_submission_data', $data, $this );
-
-		// Cache it...
-		$this->data = $data;
-
-		// Then generate a unique id from the data.
-		$this->id   = md5( wp_json_encode( $data ) );
-
-		// Finally, process the submission.
-		try {
-
-			// Each process is passed an instance of the class (with reference)
-			// and should throw an Exception whenever it encounters one.
-			$processors = apply_filters(
-				'getpaid_payment_form_submission_processors',
-				array(
-					array( $this, 'process_payment_form' ),
-					array( $this, 'process_invoice' ),
-					array( $this, 'process_fees' ),
-					array( $this, 'process_items' ),
-					array( $this, 'process_discount' ),
-					array( $this, 'process_taxes' ),
-				),
-				$this
-			);
-
-			foreach ( $processors as $processor ) {
-				call_user_func_array( $processor, array( &$this ) );
-			}
-		} catch ( GetPaid_Payment_Exception $e ) {
-			$this->last_error      = $e->getMessage();
-			$this->last_error_code = $e->getErrorCode();
-		} catch ( Exception $e ) {
-			$this->last_error      = $e->getMessage();
-			$this->last_error_code = $e->getCode();
-		}
-
-		// Fired when we are done processing a submission.
-		do_action_ref_array( 'getpaid_process_submission', array( &$this ) );
-
-	}
-
-	/*
+     * The country for the submission.
+     *
+     * @var string
+     */
+    public $country = null;
+
+    /**
+     * The state for the submission.
+     *
+     * @since 1.0.19
+     * @var string
+     */
+    public $state = null;
+
+    /**
+     * The invoice associated with the submission.
+     *
+     * @var WPInv_Invoice
+     */
+    protected $invoice = null;
+
+    /**
+     * The recurring item for the submission.
+     *
+     * @var int
+     */
+    public $has_recurring = 0;
+
+    /**
+     * An array of fees for the submission.
+     *
+     * @var array
+     */
+    protected $fees = array();
+
+    /**
+     * An array of discounts for the submission.
+     *
+     * @var array
+     */
+    protected $discounts = array();
+
+    /**
+     * An array of taxes for the submission.
+     *
+     * @var array
+     */
+    protected $taxes = array();
+
+    /**
+     * An array of items for the submission.
+     *
+     * @var GetPaid_Form_Item[]
+     */
+    protected $items = array();
+
+    /**
+     * The last error.
+     *
+     * @var string
+     */
+    public $last_error = null;
+
+    /**
+     * The last error code.
+     *
+     * @var string
+     */
+    public $last_error_code = null;
+
+    /**
+     * Class constructor.
+     *
+     */
+    public function __construct() {
+
+        // Set the state and country to the default state and country.
+        $this->country = wpinv_default_billing_country();
+        $this->state   = wpinv_get_default_state();
+
+        // Do we have an actual submission?
+        if ( isset( $_POST['getpaid_payment_form_submission'] ) ) {
+            $this->load_data( wp_kses_post_deep( wp_unslash( $_POST ) ) );
+        }
+
+    }
+
+    /**
+     * Loads submission data.
+     *
+     * @param array $data
+     */
+    public function load_data( $data ) {
+
+        // Allow plugins to filter the data.
+        $data       = apply_filters( 'getpaid_submission_data', $data, $this );
+
+        // Cache it...
+        $this->data = $data;
+
+        // Then generate a unique id from the data.
+        $this->id   = md5( wp_json_encode( $data ) );
+
+        // Finally, process the submission.
+        try {
+
+            // Each process is passed an instance of the class (with reference)
+            // and should throw an Exception whenever it encounters one.
+            $processors = apply_filters(
+                'getpaid_payment_form_submission_processors',
+                array(
+                    array( $this, 'process_payment_form' ),
+                    array( $this, 'process_invoice' ),
+                    array( $this, 'process_fees' ),
+                    array( $this, 'process_items' ),
+                    array( $this, 'process_discount' ),
+                    array( $this, 'process_taxes' ),
+                ),
+                $this
+            );
+
+            foreach ( $processors as $processor ) {
+                call_user_func_array( $processor, array( &$this ) );
+            }
+        } catch ( GetPaid_Payment_Exception $e ) {
+            $this->last_error      = $e->getMessage();
+            $this->last_error_code = $e->getErrorCode();
+        } catch ( Exception $e ) {
+            $this->last_error      = $e->getMessage();
+            $this->last_error_code = $e->getCode();
+        }
+
+        // Fired when we are done processing a submission.
+        do_action_ref_array( 'getpaid_process_submission', array( &$this ) );
+
+    }
+
+    /*
 	|--------------------------------------------------------------------------
 	| Payment Forms.
 	|--------------------------------------------------------------------------
@@ -211,39 +211,39 @@ 
 	| submission has an active payment form etc.
     */
 
-	/**
-	 * Prepares the submission's payment form.
-	 *
-	 * @since 1.0.19
-	 */
-	public function process_payment_form() {
+    /**
+     * Prepares the submission's payment form.
+     *
+     * @since 1.0.19
+     */
+    public function process_payment_form() {
 
-		// Every submission needs an active payment form.
-		if ( empty( $this->data['form_id'] ) ) {
-			throw new Exception( __( 'Missing payment form', 'invoicing' ) );
-		}
+        // Every submission needs an active payment form.
+        if ( empty( $this->data['form_id'] ) ) {
+            throw new Exception( __( 'Missing payment form', 'invoicing' ) );
+        }
 
-		// Fetch the payment form.
-		$this->payment_form = new GetPaid_Payment_Form( $this->data['form_id'] );
+        // Fetch the payment form.
+        $this->payment_form = new GetPaid_Payment_Form( $this->data['form_id'] );
 
-		if ( ! $this->payment_form->is_active() ) {
-			throw new Exception( __( 'Payment form not active', 'invoicing' ) );
-		}
+        if ( ! $this->payment_form->is_active() ) {
+            throw new Exception( __( 'Payment form not active', 'invoicing' ) );
+        }
 
-		do_action_ref_array( 'getpaid_submissions_process_payment_form', array( &$this ) );
-	}
+        do_action_ref_array( 'getpaid_submissions_process_payment_form', array( &$this ) );
+    }
 
     /**
-	 * Returns the payment form.
-	 *
-	 * @since 1.0.19
-	 * @return GetPaid_Payment_Form
-	 */
-	public function get_payment_form() {
-		return $this->payment_form;
-	}
+     * Returns the payment form.
+     *
+     * @since 1.0.19
+     * @return GetPaid_Payment_Form
+     */
+    public function get_payment_form() {
+        return $this->payment_form;
+    }
 
-	/*
+    /*
 	|--------------------------------------------------------------------------
 	| Invoices.
 	|--------------------------------------------------------------------------
@@ -252,95 +252,95 @@ 
 	| might be for an existing invoice.
 	*/
 
-	/**
-	 * Prepares the submission's invoice.
-	 *
-	 * @since 1.0.19
-	 */
-	public function process_invoice() {
-
-		// Abort if there is no invoice.
-		if ( empty( $this->data['invoice_id'] ) ) {
-
-			// Check if we are resuming a payment.
-			if ( empty( $this->data['maybe_use_invoice'] ) ) {
-				return;
-			}
-
-			$invoice = wpinv_get_invoice( $this->data['maybe_use_invoice'] );
-			if ( empty( $invoice ) || ! $invoice->has_status( 'draft, auto-draft, wpi-pending' ) ) {
-				return;
-			}
-		}
-
-		// If the submission is for an existing invoice, ensure that it exists
-		// and that it is not paid for.
-		if ( empty( $invoice ) ) {
-			$invoice = wpinv_get_invoice( $this->data['invoice_id'] );
-		}
+    /**
+     * Prepares the submission's invoice.
+     *
+     * @since 1.0.19
+     */
+    public function process_invoice() {
+
+        // Abort if there is no invoice.
+        if ( empty( $this->data['invoice_id'] ) ) {
+
+            // Check if we are resuming a payment.
+            if ( empty( $this->data['maybe_use_invoice'] ) ) {
+                return;
+            }
+
+            $invoice = wpinv_get_invoice( $this->data['maybe_use_invoice'] );
+            if ( empty( $invoice ) || ! $invoice->has_status( 'draft, auto-draft, wpi-pending' ) ) {
+                return;
+            }
+        }
+
+        // If the submission is for an existing invoice, ensure that it exists
+        // and that it is not paid for.
+        if ( empty( $invoice ) ) {
+            $invoice = wpinv_get_invoice( $this->data['invoice_id'] );
+        }
 
         if ( empty( $invoice ) ) {
-			throw new Exception( __( 'Invalid invoice', 'invoicing' ) );
-		}
-
-		if ( $invoice->is_paid() ) {
-			throw new Exception( __( 'This invoice is already paid for.', 'invoicing' ) );
-		}
-
-		$this->payment_form->invoice = $invoice;
-		if ( ! $this->payment_form->is_default() ) {
-
-			$items    = array();
-			$item_ids = array();
-
-			foreach ( $invoice->get_items() as $item ) {
-				if ( ! in_array( $item->get_id(), $item_ids ) ) {
-					$item_ids[] = $item->get_id();
-					$items[]    = $item;
-				}
-			}
-
-			foreach ( $this->payment_form->get_items() as $item ) {
-				if ( ! in_array( $item->get_id(), $item_ids ) ) {
-					$item_ids[] = $item->get_id();
-					$items[]    = $item;
-				}
-			}
-
-			$this->payment_form->set_items( $items );
-
-		} else {
-			$this->payment_form->set_items( $invoice->get_items() );
-		}
-
-		$this->country = $invoice->get_country();
-		$this->state   = $invoice->get_state();
-		$this->invoice = $invoice;
-
-		do_action_ref_array( 'getpaid_submissions_process_invoice', array( &$this ) );
-	}
-
-	/**
-	 * Returns the associated invoice.
-	 *
-	 * @since 1.0.19
-	 * @return WPInv_Invoice
-	 */
-	public function get_invoice() {
-		return $this->invoice;
-	}
-
-	/**
-	 * Checks whether there is an invoice associated with this submission.
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
-	public function has_invoice() {
-		return ! empty( $this->invoice );
-	}
-
-	/*
+            throw new Exception( __( 'Invalid invoice', 'invoicing' ) );
+        }
+
+        if ( $invoice->is_paid() ) {
+            throw new Exception( __( 'This invoice is already paid for.', 'invoicing' ) );
+        }
+
+        $this->payment_form->invoice = $invoice;
+        if ( ! $this->payment_form->is_default() ) {
+
+            $items    = array();
+            $item_ids = array();
+
+            foreach ( $invoice->get_items() as $item ) {
+                if ( ! in_array( $item->get_id(), $item_ids ) ) {
+                    $item_ids[] = $item->get_id();
+                    $items[]    = $item;
+                }
+            }
+
+            foreach ( $this->payment_form->get_items() as $item ) {
+                if ( ! in_array( $item->get_id(), $item_ids ) ) {
+                    $item_ids[] = $item->get_id();
+                    $items[]    = $item;
+                }
+            }
+
+            $this->payment_form->set_items( $items );
+
+        } else {
+            $this->payment_form->set_items( $invoice->get_items() );
+        }
+
+        $this->country = $invoice->get_country();
+        $this->state   = $invoice->get_state();
+        $this->invoice = $invoice;
+
+        do_action_ref_array( 'getpaid_submissions_process_invoice', array( &$this ) );
+    }
+
+    /**
+     * Returns the associated invoice.
+     *
+     * @since 1.0.19
+     * @return WPInv_Invoice
+     */
+    public function get_invoice() {
+        return $this->invoice;
+    }
+
+    /**
+     * Checks whether there is an invoice associated with this submission.
+     *
+     * @since 1.0.19
+     * @return bool
+     */
+    public function has_invoice() {
+        return ! empty( $this->invoice );
+    }
+
+    /*
 	|--------------------------------------------------------------------------
 	| Items.
 	|--------------------------------------------------------------------------
@@ -349,129 +349,129 @@ 
 	| recurring item. But can have an unlimited number of non-recurring items.
 	*/
 
-	/**
-	 * Prepares the submission's items.
-	 *
-	 * @since 1.0.19
-	 */
-	public function process_items() {
-
-		$processor = new GetPaid_Payment_Form_Submission_Items( $this );
-
-		foreach ( $processor->items as $item ) {
-			$this->add_item( $item );
-		}
-
-		do_action_ref_array( 'getpaid_submissions_process_items', array( &$this ) );
-	}
-
-	/**
-	 * Adds an item to the submission.
-	 *
-	 * @since 1.0.19
-	 * @param GetPaid_Form_Item $item
-	 */
-	public function add_item( $item ) {
-
-		// Make sure that it is available for purchase.
-		if ( ! $item->can_purchase() || isset( $this->items[ $item->get_id() ] ) ) {
-			return;
-		}
-
-		// Each submission can only contain one recurring item.
-		if ( $item->is_recurring() ) {
-			$this->has_recurring = $item->get_id();
-		}
-
-		// Update the items and totals.
-		$this->items[ $item->get_id() ]         = $item;
-		$this->totals['subtotal']['initial']   += $item->get_sub_total();
-		$this->totals['subtotal']['recurring'] += $item->get_recurring_sub_total();
-
-	}
-
-	/**
-	 * Removes a specific item.
-	 *
-	 * You should not call this method after the discounts and taxes
-	 * have been calculated.
-	 *
-	 * @since 1.0.19
-	 */
-	public function remove_item( $item_id ) {
-
-		if ( isset( $this->items[ $item_id ] ) ) {
-			$this->totals['subtotal']['initial']   -= $this->items[ $item_id ]->get_sub_total();
-			$this->totals['subtotal']['recurring'] -= $this->items[ $item_id ]->get_recurring_sub_total();
-
-			if ( $this->items[ $item_id ]->is_recurring() ) {
-				$this->has_recurring = 0;
-			}
-
-			unset( $this->items[ $item_id ] );
-		}
-
-	}
-
-	/**
-	 * Returns the subtotal.
-	 *
-	 * @since 1.0.19
-	 */
-	public function get_subtotal() {
-
-		if ( wpinv_prices_include_tax() ) {
-			return $this->totals['subtotal']['initial'] - $this->totals['taxes']['initial'];
-		}
-
-		return $this->totals['subtotal']['initial'];
-	}
-
-	/**
-	 * Returns the recurring subtotal.
-	 *
-	 * @since 1.0.19
-	 */
-	public function get_recurring_subtotal() {
-
-		if ( wpinv_prices_include_tax() ) {
-			return $this->totals['subtotal']['recurring'] - $this->totals['taxes']['recurring'];
-		}
-
-		return $this->totals['subtotal']['recurring'];
-	}
-
-	/**
-	 * Returns all items.
-	 *
-	 * @since 1.0.19
-	 * @return GetPaid_Form_Item[]
-	 */
-	public function get_items() {
-		return $this->items;
-	}
-
-	/**
-	 * Checks if there's a single subscription group in the submission.
-	 *
-	 * @since 2.3.0
-	 * @return bool
-	 */
-	public function has_subscription_group() {
-		return $this->has_recurring && getpaid_should_group_subscriptions( $this ) && 1 == count( getpaid_get_subscription_groups( $this ) );
-	}
-
-	/**
-	 * Checks if there are multipe subscription groups in the submission.
-	 *
-	 * @since 2.3.0
-	 * @return bool
-	 */
-	public function has_multiple_subscription_groups() {
-		return $this->has_recurring && 1 < count( getpaid_get_subscription_groups( $this ) );
-	}
-
-	/*
+    /**
+     * Prepares the submission's items.
+     *
+     * @since 1.0.19
+     */
+    public function process_items() {
+
+        $processor = new GetPaid_Payment_Form_Submission_Items( $this );
+
+        foreach ( $processor->items as $item ) {
+            $this->add_item( $item );
+        }
+
+        do_action_ref_array( 'getpaid_submissions_process_items', array( &$this ) );
+    }
+
+    /**
+     * Adds an item to the submission.
+     *
+     * @since 1.0.19
+     * @param GetPaid_Form_Item $item
+     */
+    public function add_item( $item ) {
+
+        // Make sure that it is available for purchase.
+        if ( ! $item->can_purchase() || isset( $this->items[ $item->get_id() ] ) ) {
+            return;
+        }
+
+        // Each submission can only contain one recurring item.
+        if ( $item->is_recurring() ) {
+            $this->has_recurring = $item->get_id();
+        }
+
+        // Update the items and totals.
+        $this->items[ $item->get_id() ]         = $item;
+        $this->totals['subtotal']['initial']   += $item->get_sub_total();
+        $this->totals['subtotal']['recurring'] += $item->get_recurring_sub_total();
+
+    }
+
+    /**
+     * Removes a specific item.
+     *
+     * You should not call this method after the discounts and taxes
+     * have been calculated.
+     *
+     * @since 1.0.19
+     */
+    public function remove_item( $item_id ) {
+
+        if ( isset( $this->items[ $item_id ] ) ) {
+            $this->totals['subtotal']['initial']   -= $this->items[ $item_id ]->get_sub_total();
+            $this->totals['subtotal']['recurring'] -= $this->items[ $item_id ]->get_recurring_sub_total();
+
+            if ( $this->items[ $item_id ]->is_recurring() ) {
+                $this->has_recurring = 0;
+            }
+
+            unset( $this->items[ $item_id ] );
+        }
+
+    }
+
+    /**
+     * Returns the subtotal.
+     *
+     * @since 1.0.19
+     */
+    public function get_subtotal() {
+
+        if ( wpinv_prices_include_tax() ) {
+            return $this->totals['subtotal']['initial'] - $this->totals['taxes']['initial'];
+        }
+
+        return $this->totals['subtotal']['initial'];
+    }
+
+    /**
+     * Returns the recurring subtotal.
+     *
+     * @since 1.0.19
+     */
+    public function get_recurring_subtotal() {
+
+        if ( wpinv_prices_include_tax() ) {
+            return $this->totals['subtotal']['recurring'] - $this->totals['taxes']['recurring'];
+        }
+
+        return $this->totals['subtotal']['recurring'];
+    }
+
+    /**
+     * Returns all items.
+     *
+     * @since 1.0.19
+     * @return GetPaid_Form_Item[]
+     */
+    public function get_items() {
+        return $this->items;
+    }
+
+    /**
+     * Checks if there's a single subscription group in the submission.
+     *
+     * @since 2.3.0
+     * @return bool
+     */
+    public function has_subscription_group() {
+        return $this->has_recurring && getpaid_should_group_subscriptions( $this ) && 1 == count( getpaid_get_subscription_groups( $this ) );
+    }
+
+    /**
+     * Checks if there are multipe subscription groups in the submission.
+     *
+     * @since 2.3.0
+     * @return bool
+     */
+    public function has_multiple_subscription_groups() {
+        return $this->has_recurring && 1 < count( getpaid_get_subscription_groups( $this ) );
+    }
+
+    /*
 	|--------------------------------------------------------------------------
 	| Taxes
 	|--------------------------------------------------------------------------
@@ -480,128 +480,128 @@ 
 	| or only one-time.
     */
 
-	/**
-	 * Prepares the submission's taxes.
-	 *
-	 * @since 1.0.19
-	 */
-	public function process_taxes() {
-
-		// Abort if we're not using taxes.
-		if ( ! $this->use_taxes() ) {
-			return;
-		}
-
-		// If a custom country && state has been passed in, use it to calculate taxes.
-		$country = $this->get_field( 'wpinv_country', 'billing' );
-		if ( ! empty( $country ) ) {
-			$this->country = $country;
-		}
-
-		$state = $this->get_field( 'wpinv_state', 'billing' );
-		if ( ! empty( $state ) ) {
-			$this->state = $state;
-		}
-
-		// Confirm if the provided country and the ip country are similar.
-		$address_confirmed = $this->get_field( 'confirm-address' );
-		if ( isset( $_POST['billing']['country'] ) && wpinv_should_validate_vat_number() && getpaid_get_ip_country() != $this->country && empty( $address_confirmed ) ) {
-			throw new Exception( __( 'The country of your current location must be the same as the country of your billing location or you must confirm the billing address is your home country.', 'invoicing' ) );
-		}
-
-		// Abort if the country is not taxable.
-		if ( ! wpinv_is_country_taxable( $this->country ) ) {
-			return;
-		}
-
-		$processor = new GetPaid_Payment_Form_Submission_Taxes( $this );
-
-		foreach ( $processor->taxes as $tax ) {
-			$this->add_tax( $tax );
-		}
-
-		do_action_ref_array( 'getpaid_submissions_process_taxes', array( &$this ) );
-	}
-
-	/**
-	 * Adds a tax to the submission.
-	 *
-	 * @param array $tax An array of tax details. name, initial_tax, and recurring_tax are required.
-	 * @since 1.0.19
-	 */
-	public function add_tax( $tax ) {
-
-		if ( wpinv_round_tax_per_tax_rate() ) {
-			$tax['initial_tax']   = wpinv_round_amount( $tax['initial_tax'] );
-			$tax['recurring_tax'] = wpinv_round_amount( $tax['recurring_tax'] );
-		}
-
-		$this->taxes[ $tax['name'] ]         = $tax;
-		$this->totals['taxes']['initial']   += wpinv_sanitize_amount( $tax['initial_tax'] );
-		$this->totals['taxes']['recurring'] += wpinv_sanitize_amount( $tax['recurring_tax'] );
-
-	}
-
-	/**
-	 * Removes a specific tax.
-	 *
-	 * @since 1.0.19
-	 */
-	public function remove_tax( $tax_name ) {
-
-		if ( isset( $this->taxes[ $tax_name ] ) ) {
-			$this->totals['taxes']['initial']   -= $this->taxes[ $tax_name ]['initial_tax'];
-			$this->totals['taxes']['recurring'] -= $this->taxes[ $tax_name ]['recurring_tax'];
-			unset( $this->taxes[ $tax_name ] );
-		}
-
-	}
-
-	/**
-	 * Whether or not we'll use taxes for the submission.
-	 *
-	 * @since 1.0.19
-	 */
-	public function use_taxes() {
-
-		$use_taxes = wpinv_use_taxes();
-
-		if ( $this->has_invoice() && ! $this->invoice->is_taxable() ) {
-			$use_taxes = false;
-		}
-
-		return apply_filters( 'getpaid_submission_use_taxes', $use_taxes, $this );
-
-	}
-
-	/**
-	 * Returns the tax.
-	 *
-	 * @since 1.0.19
-	 */
-	public function get_tax() {
-		return $this->totals['taxes']['initial'];
-	}
-
-	/**
-	 * Returns the recurring tax.
-	 *
-	 * @since 1.0.19
-	 */
-	public function get_recurring_tax() {
-		return $this->totals['taxes']['recurring'];
-	}
-
-	/**
-	 * Returns all taxes.
-	 *
-	 * @since 1.0.19
-	 */
-	public function get_taxes() {
-		return $this->taxes;
-	}
-
-	/*
+    /**
+     * Prepares the submission's taxes.
+     *
+     * @since 1.0.19
+     */
+    public function process_taxes() {
+
+        // Abort if we're not using taxes.
+        if ( ! $this->use_taxes() ) {
+            return;
+        }
+
+        // If a custom country && state has been passed in, use it to calculate taxes.
+        $country = $this->get_field( 'wpinv_country', 'billing' );
+        if ( ! empty( $country ) ) {
+            $this->country = $country;
+        }
+
+        $state = $this->get_field( 'wpinv_state', 'billing' );
+        if ( ! empty( $state ) ) {
+            $this->state = $state;
+        }
+
+        // Confirm if the provided country and the ip country are similar.
+        $address_confirmed = $this->get_field( 'confirm-address' );
+        if ( isset( $_POST['billing']['country'] ) && wpinv_should_validate_vat_number() && getpaid_get_ip_country() != $this->country && empty( $address_confirmed ) ) {
+            throw new Exception( __( 'The country of your current location must be the same as the country of your billing location or you must confirm the billing address is your home country.', 'invoicing' ) );
+        }
+
+        // Abort if the country is not taxable.
+        if ( ! wpinv_is_country_taxable( $this->country ) ) {
+            return;
+        }
+
+        $processor = new GetPaid_Payment_Form_Submission_Taxes( $this );
+
+        foreach ( $processor->taxes as $tax ) {
+            $this->add_tax( $tax );
+        }
+
+        do_action_ref_array( 'getpaid_submissions_process_taxes', array( &$this ) );
+    }
+
+    /**
+     * Adds a tax to the submission.
+     *
+     * @param array $tax An array of tax details. name, initial_tax, and recurring_tax are required.
+     * @since 1.0.19
+     */
+    public function add_tax( $tax ) {
+
+        if ( wpinv_round_tax_per_tax_rate() ) {
+            $tax['initial_tax']   = wpinv_round_amount( $tax['initial_tax'] );
+            $tax['recurring_tax'] = wpinv_round_amount( $tax['recurring_tax'] );
+        }
+
+        $this->taxes[ $tax['name'] ]         = $tax;
+        $this->totals['taxes']['initial']   += wpinv_sanitize_amount( $tax['initial_tax'] );
+        $this->totals['taxes']['recurring'] += wpinv_sanitize_amount( $tax['recurring_tax'] );
+
+    }
+
+    /**
+     * Removes a specific tax.
+     *
+     * @since 1.0.19
+     */
+    public function remove_tax( $tax_name ) {
+
+        if ( isset( $this->taxes[ $tax_name ] ) ) {
+            $this->totals['taxes']['initial']   -= $this->taxes[ $tax_name ]['initial_tax'];
+            $this->totals['taxes']['recurring'] -= $this->taxes[ $tax_name ]['recurring_tax'];
+            unset( $this->taxes[ $tax_name ] );
+        }
+
+    }
+
+    /**
+     * Whether or not we'll use taxes for the submission.
+     *
+     * @since 1.0.19
+     */
+    public function use_taxes() {
+
+        $use_taxes = wpinv_use_taxes();
+
+        if ( $this->has_invoice() && ! $this->invoice->is_taxable() ) {
+            $use_taxes = false;
+        }
+
+        return apply_filters( 'getpaid_submission_use_taxes', $use_taxes, $this );
+
+    }
+
+    /**
+     * Returns the tax.
+     *
+     * @since 1.0.19
+     */
+    public function get_tax() {
+        return $this->totals['taxes']['initial'];
+    }
+
+    /**
+     * Returns the recurring tax.
+     *
+     * @since 1.0.19
+     */
+    public function get_recurring_tax() {
+        return $this->totals['taxes']['recurring'];
+    }
+
+    /**
+     * Returns all taxes.
+     *
+     * @since 1.0.19
+     */
+    public function get_taxes() {
+        return $this->taxes;
+    }
+
+    /*
 	|--------------------------------------------------------------------------
 	| Discounts
 	|--------------------------------------------------------------------------
@@ -610,99 +610,99 @@ 
 	| or only one-time. They also do not have to come from a discount code.
     */
 
-	/**
-	 * Prepares the submission's discount.
-	 *
-	 * @since 1.0.19
-	 */
-	public function process_discount() {
-
-		$initial_total    = $this->get_subtotal() + $this->get_fee() + $this->get_tax();
-		$recurring_total  = $this->get_recurring_subtotal() + $this->get_recurring_fee() + $this->get_recurring_tax();
-		$processor        = new GetPaid_Payment_Form_Submission_Discount( $this, $initial_total, $recurring_total );
-
-		foreach ( $processor->discounts as $discount ) {
-			$this->add_discount( $discount );
-		}
-
-		do_action_ref_array( 'getpaid_submissions_process_discounts', array( &$this ) );
-	}
-
-	/**
-	 * Adds a discount to the submission.
-	 *
-	 * @param array $discount An array of discount details. name, initial_discount, and recurring_discount are required. Include discount_code if the discount is from a discount code.
-	 * @since 1.0.19
-	 */
-	public function add_discount( $discount ) {
-		$this->discounts[ $discount['name'] ]   = $discount;
-		$this->totals['discount']['initial']   += wpinv_sanitize_amount( $discount['initial_discount'] );
-		$this->totals['discount']['recurring'] += wpinv_sanitize_amount( $discount['recurring_discount'] );
-	}
-
-	/**
-	 * Removes a discount from the submission.
-	 *
-	 * @since 1.0.19
-	 */
-	public function remove_discount( $name ) {
-
-		if ( isset( $this->discounts[ $name ] ) ) {
-			$this->totals['discount']['initial']   -= $this->discounts[ $name ]['initial_discount'];
-			$this->totals['discount']['recurring'] -= $this->discounts[ $name ]['recurring_discount'];
-			unset( $this->discounts[ $name ] );
-		}
-
-	}
-
-	/**
-	 * Checks whether there is a discount code associated with this submission.
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
-	public function has_discount_code() {
-		return ! empty( $this->discounts['discount_code'] );
-	}
-
-	/**
-	 * Returns the discount code.
-	 *
-	 * @since 1.0.19
-	 * @return string
-	 */
-	public function get_discount_code() {
-		return $this->has_discount_code() ? $this->discounts['discount_code']['discount_code'] : '';
-	}
-
-	/**
-	 * Returns the discount.
-	 *
-	 * @since 1.0.19
-	 */
-	public function get_discount() {
-		return $this->totals['discount']['initial'];
-	}
-
-	/**
-	 * Returns the recurring discount.
-	 *
-	 * @since 1.0.19
-	 */
-	public function get_recurring_discount() {
-		return $this->totals['discount']['recurring'];
-	}
-
-	/**
-	 * Returns all discounts.
-	 *
-	 * @since 1.0.19
-	 */
-	public function get_discounts() {
-		return $this->discounts;
-	}
-
-	/*
+    /**
+     * Prepares the submission's discount.
+     *
+     * @since 1.0.19
+     */
+    public function process_discount() {
+
+        $initial_total    = $this->get_subtotal() + $this->get_fee() + $this->get_tax();
+        $recurring_total  = $this->get_recurring_subtotal() + $this->get_recurring_fee() + $this->get_recurring_tax();
+        $processor        = new GetPaid_Payment_Form_Submission_Discount( $this, $initial_total, $recurring_total );
+
+        foreach ( $processor->discounts as $discount ) {
+            $this->add_discount( $discount );
+        }
+
+        do_action_ref_array( 'getpaid_submissions_process_discounts', array( &$this ) );
+    }
+
+    /**
+     * Adds a discount to the submission.
+     *
+     * @param array $discount An array of discount details. name, initial_discount, and recurring_discount are required. Include discount_code if the discount is from a discount code.
+     * @since 1.0.19
+     */
+    public function add_discount( $discount ) {
+        $this->discounts[ $discount['name'] ]   = $discount;
+        $this->totals['discount']['initial']   += wpinv_sanitize_amount( $discount['initial_discount'] );
+        $this->totals['discount']['recurring'] += wpinv_sanitize_amount( $discount['recurring_discount'] );
+    }
+
+    /**
+     * Removes a discount from the submission.
+     *
+     * @since 1.0.19
+     */
+    public function remove_discount( $name ) {
+
+        if ( isset( $this->discounts[ $name ] ) ) {
+            $this->totals['discount']['initial']   -= $this->discounts[ $name ]['initial_discount'];
+            $this->totals['discount']['recurring'] -= $this->discounts[ $name ]['recurring_discount'];
+            unset( $this->discounts[ $name ] );
+        }
+
+    }
+
+    /**
+     * Checks whether there is a discount code associated with this submission.
+     *
+     * @since 1.0.19
+     * @return bool
+     */
+    public function has_discount_code() {
+        return ! empty( $this->discounts['discount_code'] );
+    }
+
+    /**
+     * Returns the discount code.
+     *
+     * @since 1.0.19
+     * @return string
+     */
+    public function get_discount_code() {
+        return $this->has_discount_code() ? $this->discounts['discount_code']['discount_code'] : '';
+    }
+
+    /**
+     * Returns the discount.
+     *
+     * @since 1.0.19
+     */
+    public function get_discount() {
+        return $this->totals['discount']['initial'];
+    }
+
+    /**
+     * Returns the recurring discount.
+     *
+     * @since 1.0.19
+     */
+    public function get_recurring_discount() {
+        return $this->totals['discount']['recurring'];
+    }
+
+    /**
+     * Returns all discounts.
+     *
+     * @since 1.0.19
+     */
+    public function get_discounts() {
+        return $this->discounts;
+    }
+
+    /*
 	|--------------------------------------------------------------------------
 	| Fees
 	|--------------------------------------------------------------------------
@@ -712,100 +712,100 @@ 
 	| fees.
     */
 
-	/**
-	 * Prepares the submission's fees.
-	 *
-	 * @since 1.0.19
-	 */
-	public function process_fees() {
-
-		$fees_processor = new GetPaid_Payment_Form_Submission_Fees( $this );
-
-		foreach ( $fees_processor->fees as $fee ) {
-			$this->add_fee( $fee );
-		}
-
-		do_action_ref_array( 'getpaid_submissions_process_fees', array( &$this ) );
-	}
-
-	/**
-	 * Adds a fee to the submission.
-	 *
-	 * @param array $fee An array of fee details. name, initial_fee, and recurring_fee are required.
-	 * @since 1.0.19
-	 */
-	public function add_fee( $fee ) {
-
-		if ( $fee['name'] == 'shipping' ) {
-			$this->totals['shipping']['initial']   += wpinv_sanitize_amount( $fee['initial_fee'] );
-			$this->totals['shipping']['recurring'] += wpinv_sanitize_amount( $fee['recurring_fee'] );
-			return;
-		}
-
-		$this->fees[ $fee['name'] ]         = $fee;
-		$this->totals['fees']['initial']   += wpinv_sanitize_amount( $fee['initial_fee'] );
-		$this->totals['fees']['recurring'] += wpinv_sanitize_amount( $fee['recurring_fee'] );
-
-	}
-
-	/**
-	 * Removes a fee from the submission.
-	 *
-	 * @since 1.0.19
-	 */
-	public function remove_fee( $name ) {
-
-		if ( isset( $this->fees[ $name ] ) ) {
-			$this->totals['fees']['initial']   -= $this->fees[ $name ]['initial_fee'];
-			$this->totals['fees']['recurring'] -= $this->fees[ $name ]['recurring_fee'];
-			unset( $this->fees[ $name ] );
-		}
-
-		if ( 'shipping' == $name ) {
-			$this->totals['shipping']['initial']   = 0;
-			$this->totals['shipping']['recurring'] = 0;
-		}
-
-	}
-
-	/**
-	 * Returns the fees.
-	 *
-	 * @since 1.0.19
-	 */
-	public function get_fee() {
-		return $this->totals['fees']['initial'];
-	}
-
-	/**
-	 * Returns the recurring fees.
-	 *
-	 * @since 1.0.19
-	 */
-	public function get_recurring_fee() {
-		return $this->totals['fees']['recurring'];
-	}
-
-	/**
-	 * Returns all fees.
-	 *
-	 * @since 1.0.19
-	 */
-	public function get_fees() {
-		return $this->fees;
-	}
-
-	/**
-	 * Checks if there are any fees for the form.
-	 *
-	 * @return bool
-	 * @since 1.0.19
-	 */
-	public function has_fees() {
-		return count( $this->fees ) !== 0;
-	}
-
-	/*
+    /**
+     * Prepares the submission's fees.
+     *
+     * @since 1.0.19
+     */
+    public function process_fees() {
+
+        $fees_processor = new GetPaid_Payment_Form_Submission_Fees( $this );
+
+        foreach ( $fees_processor->fees as $fee ) {
+            $this->add_fee( $fee );
+        }
+
+        do_action_ref_array( 'getpaid_submissions_process_fees', array( &$this ) );
+    }
+
+    /**
+     * Adds a fee to the submission.
+     *
+     * @param array $fee An array of fee details. name, initial_fee, and recurring_fee are required.
+     * @since 1.0.19
+     */
+    public function add_fee( $fee ) {
+
+        if ( $fee['name'] == 'shipping' ) {
+            $this->totals['shipping']['initial']   += wpinv_sanitize_amount( $fee['initial_fee'] );
+            $this->totals['shipping']['recurring'] += wpinv_sanitize_amount( $fee['recurring_fee'] );
+            return;
+        }
+
+        $this->fees[ $fee['name'] ]         = $fee;
+        $this->totals['fees']['initial']   += wpinv_sanitize_amount( $fee['initial_fee'] );
+        $this->totals['fees']['recurring'] += wpinv_sanitize_amount( $fee['recurring_fee'] );
+
+    }
+
+    /**
+     * Removes a fee from the submission.
+     *
+     * @since 1.0.19
+     */
+    public function remove_fee( $name ) {
+
+        if ( isset( $this->fees[ $name ] ) ) {
+            $this->totals['fees']['initial']   -= $this->fees[ $name ]['initial_fee'];
+            $this->totals['fees']['recurring'] -= $this->fees[ $name ]['recurring_fee'];
+            unset( $this->fees[ $name ] );
+        }
+
+        if ( 'shipping' == $name ) {
+            $this->totals['shipping']['initial']   = 0;
+            $this->totals['shipping']['recurring'] = 0;
+        }
+
+    }
+
+    /**
+     * Returns the fees.
+     *
+     * @since 1.0.19
+     */
+    public function get_fee() {
+        return $this->totals['fees']['initial'];
+    }
+
+    /**
+     * Returns the recurring fees.
+     *
+     * @since 1.0.19
+     */
+    public function get_recurring_fee() {
+        return $this->totals['fees']['recurring'];
+    }
+
+    /**
+     * Returns all fees.
+     *
+     * @since 1.0.19
+     */
+    public function get_fees() {
+        return $this->fees;
+    }
+
+    /**
+     * Checks if there are any fees for the form.
+     *
+     * @return bool
+     * @since 1.0.19
+     */
+    public function has_fees() {
+        return count( $this->fees ) !== 0;
+    }
+
+    /*
 	|--------------------------------------------------------------------------
 	| MISC
 	|--------------------------------------------------------------------------
@@ -813,147 +813,147 @@ 
 	| Extra submission functions.
     */
 
-	/**
-	 * Returns the shipping amount.
-	 *
-	 * @since 1.0.19
-	 */
-	public function get_shipping() {
-		return $this->totals['shipping']['initial'];
-	}
-
-	/**
-	 * Returns the recurring shipping.
-	 *
-	 * @since 1.0.19
-	 */
-	public function get_recurring_shipping() {
-		return $this->totals['shipping']['recurring'];
-	}
-
-	/**
-	 * Checks if there are any shipping fees for the form.
-	 *
-	 * @return bool
-	 * @since 1.0.19
-	 */
-	public function has_shipping() {
-		return apply_filters( 'getpaid_payment_form_has_shipping', false, $this );
-	}
-
-	/**
-	 * Checks if this is the initial fetch.
-	 *
-	 * @return bool
-	 * @since 1.0.19
-	 */
-	public function is_initial_fetch() {
-		return empty( $this->data['initial_state'] );
-	}
-
-	/**
-	 * Returns the total amount to collect for this submission.
-	 *
-	 * @since 1.0.19
-	 */
-	public function get_total() {
-		$total = $this->get_subtotal() + $this->get_fee() + $this->get_tax() + $this->get_shipping() - $this->get_discount();
-		return max( $total, 0 );
-	}
-
-	/**
-	 * Returns the recurring total amount to collect for this submission.
-	 *
-	 * @since 1.0.19
-	 */
-	public function get_recurring_total() {
-		$total = $this->get_recurring_subtotal() + $this->get_recurring_fee() + $this->get_recurring_tax() + $this->get_recurring_shipping() - $this->get_recurring_discount();
-		return max( $total, 0 );
-	}
-
-	/**
-	 * Whether payment details should be collected for this submission.
-	 *
-	 * @since 1.0.19
-	 */
-	public function should_collect_payment_details() {
-		$initial   = $this->get_total();
-		$recurring = $this->get_recurring_total();
-
-		if ( $this->has_recurring == 0 ) {
-			$recurring = 0;
-		}
-
-		$collect = $initial > 0 || $recurring > 0;
-		return apply_filters( 'getpaid_submission_should_collect_payment_details', $collect, $this );
-	}
-
-	/**
-	 * Returns the billing email of the user.
-	 *
-	 * @since 1.0.19
-	 */
-	public function get_billing_email() {
-		return apply_filters( 'getpaid_get_submission_billing_email', $this->get_field( 'billing_email' ), $this );
-	}
-
-	/**
-	 * Checks if the submitter has a billing email.
-	 *
-	 * @since 1.0.19
-	 */
-	public function has_billing_email() {
-		$billing_email = $this->get_billing_email();
-		return ! empty( $billing_email ) && is_email( $billing_email );
-	}
-
-	/**
-	 * Returns the appropriate currency for the submission.
-	 *
-	 * @since 1.0.19
-	 * @return string
-	 */
-	public function get_currency() {
-		return $this->has_invoice() ? $this->invoice->get_currency() : wpinv_get_currency();
-    }
-
-    /**
-	 * Returns the raw submission data.
-	 *
-	 * @since 1.0.19
-	 * @return array
-	 */
-	public function get_data() {
-		return $this->data;
-	}
-
-	/**
-	 * Returns a field from the submission data
-	 *
-	 * @param string $field
-	 * @since 1.0.19
-	 * @return mixed|null
-	 */
-	public function get_field( $field, $sub_array_key = null ) {
-		return getpaid_get_array_field( $this->data, $field, $sub_array_key );
-	}
-
-	/**
-	 * Checks if a required field is set.
-	 *
-	 * @since 1.0.19
-	 */
-	public function is_required_field_set( $field ) {
-		return empty( $field['required'] ) || ! empty( $this->data[ $field['id'] ] );
-	}
-
-	/**
-	 * Formats an amount
-	 *
-	 * @since 1.0.19
-	 */
-	public function format_amount( $amount ) {
-		return wpinv_price( $amount, $this->get_currency() );
-	}
+    /**
+     * Returns the shipping amount.
+     *
+     * @since 1.0.19
+     */
+    public function get_shipping() {
+        return $this->totals['shipping']['initial'];
+    }
+
+    /**
+     * Returns the recurring shipping.
+     *
+     * @since 1.0.19
+     */
+    public function get_recurring_shipping() {
+        return $this->totals['shipping']['recurring'];
+    }
+
+    /**
+     * Checks if there are any shipping fees for the form.
+     *
+     * @return bool
+     * @since 1.0.19
+     */
+    public function has_shipping() {
+        return apply_filters( 'getpaid_payment_form_has_shipping', false, $this );
+    }
+
+    /**
+     * Checks if this is the initial fetch.
+     *
+     * @return bool
+     * @since 1.0.19
+     */
+    public function is_initial_fetch() {
+        return empty( $this->data['initial_state'] );
+    }
+
+    /**
+     * Returns the total amount to collect for this submission.
+     *
+     * @since 1.0.19
+     */
+    public function get_total() {
+        $total = $this->get_subtotal() + $this->get_fee() + $this->get_tax() + $this->get_shipping() - $this->get_discount();
+        return max( $total, 0 );
+    }
+
+    /**
+     * Returns the recurring total amount to collect for this submission.
+     *
+     * @since 1.0.19
+     */
+    public function get_recurring_total() {
+        $total = $this->get_recurring_subtotal() + $this->get_recurring_fee() + $this->get_recurring_tax() + $this->get_recurring_shipping() - $this->get_recurring_discount();
+        return max( $total, 0 );
+    }
+
+    /**
+     * Whether payment details should be collected for this submission.
+     *
+     * @since 1.0.19
+     */
+    public function should_collect_payment_details() {
+        $initial   = $this->get_total();
+        $recurring = $this->get_recurring_total();
+
+        if ( $this->has_recurring == 0 ) {
+            $recurring = 0;
+        }
+
+        $collect = $initial > 0 || $recurring > 0;
+        return apply_filters( 'getpaid_submission_should_collect_payment_details', $collect, $this );
+    }
+
+    /**
+     * Returns the billing email of the user.
+     *
+     * @since 1.0.19
+     */
+    public function get_billing_email() {
+        return apply_filters( 'getpaid_get_submission_billing_email', $this->get_field( 'billing_email' ), $this );
+    }
+
+    /**
+     * Checks if the submitter has a billing email.
+     *
+     * @since 1.0.19
+     */
+    public function has_billing_email() {
+        $billing_email = $this->get_billing_email();
+        return ! empty( $billing_email ) && is_email( $billing_email );
+    }
+
+    /**
+     * Returns the appropriate currency for the submission.
+     *
+     * @since 1.0.19
+     * @return string
+     */
+    public function get_currency() {
+        return $this->has_invoice() ? $this->invoice->get_currency() : wpinv_get_currency();
+    }
+
+    /**
+     * Returns the raw submission data.
+     *
+     * @since 1.0.19
+     * @return array
+     */
+    public function get_data() {
+        return $this->data;
+    }
+
+    /**
+     * Returns a field from the submission data
+     *
+     * @param string $field
+     * @since 1.0.19
+     * @return mixed|null
+     */
+    public function get_field( $field, $sub_array_key = null ) {
+        return getpaid_get_array_field( $this->data, $field, $sub_array_key );
+    }
+
+    /**
+     * Checks if a required field is set.
+     *
+     * @since 1.0.19
+     */
+    public function is_required_field_set( $field ) {
+        return empty( $field['required'] ) || ! empty( $this->data[ $field['id'] ] );
+    }
+
+    /**
+     * Formats an amount
+     *
+     * @since 1.0.19
+     */
+    public function format_amount( $amount ) {
+        return wpinv_price( $amount, $this->get_currency() );
+    }
 
 }

templates/payment-forms/cart-item.php

Indentation +123 added lines, -123 removed lines

@@ -26,71 +26,71 @@ 
 
 				<?php
 
-					// Fires before printing a line item column.
-					do_action( "getpaid_form_cart_item_before_$key", $item, $form );
+                    // Fires before printing a line item column.
+                    do_action( "getpaid_form_cart_item_before_$key", $item, $form );
 
-					// Item name.
-					if ( 'name' === $key ) {
+                    // Item name.
+                    if ( 'name' === $key ) {
 
 
-						ob_start();
+                        ob_start();
 
-						// Add an optional description.
-						$description = $item->get_description();
+                        // Add an optional description.
+                        $description = $item->get_description();
 
-						if ( ! empty( $description ) ) {
-							echo "<small class='form-text text-muted pr-2 m-0'>" . wp_kses_post( $description ) . '</small>';
-						}
+                        if ( ! empty( $description ) ) {
+                            echo "<small class='form-text text-muted pr-2 m-0'>" . wp_kses_post( $description ) . '</small>';
+                        }
 
-						// Price help text.
-						$description = getpaid_item_recurring_price_help_text( $item, $currency );
-						if ( $description ) {
-							echo "<small class='getpaid-form-item-price-desc form-text text-muted font-italic pr-2 m-0'>" . wp_kses_post( $description ) . '</small>';
-						}
+                        // Price help text.
+                        $description = getpaid_item_recurring_price_help_text( $item, $currency );
+                        if ( $description ) {
+                            echo "<small class='getpaid-form-item-price-desc form-text text-muted font-italic pr-2 m-0'>" . wp_kses_post( $description ) . '</small>';
+                        }
 
-						do_action( 'getpaid_payment_form_cart_item_description', $item, $form );
+                        do_action( 'getpaid_payment_form_cart_item_description', $item, $form );
 
-						if ( wpinv_current_user_can_manage_invoicing() ) {
+                        if ( wpinv_current_user_can_manage_invoicing() ) {
 
-							edit_post_link(
-								__( 'Edit this item.', 'invoicing' ),
-								'<small class="form-text text-muted">',
-								'</small>',
-								$item->get_id(),
-								'text-danger'
-							);
+                            edit_post_link(
+                                __( 'Edit this item.', 'invoicing' ),
+                                '<small class="form-text text-muted">',
+                                '</small>',
+                                $item->get_id(),
+                                'text-danger'
+                            );
 
-						}
+                        }
 
-						$description = ob_get_clean();
+                        $description = ob_get_clean();
 
-						// Display the name.
-						$tootip = empty( $description ) ? '' : '&nbsp;<i class="fas fa-xs fa-info gp-tooltip d-sm-none text-muted"></i>';
+                        // Display the name.
+                        $tootip = empty( $description ) ? '' : '&nbsp;<i class="fas fa-xs fa-info gp-tooltip d-sm-none text-muted"></i>';
 
-						$has_featured_image = has_post_thumbnail( $item->get_id() );
+                        $has_featured_image = has_post_thumbnail( $item->get_id() );
 
-						if ( $has_featured_image ) {
-							echo '<div class="d-flex align-items-center getpaid-form-item-has-featured-image">';
-							echo '<div class="getpaid-form-item-image-container mr-2">';
-							echo get_the_post_thumbnail( $item->get_id(), 'thumbnail', array( 'class' => 'getpaid-form-item-image mb-0' ) );
-							echo '</div>';
-							echo '<div class="getpaid-form-item-name-container">';
-						}
+                        if ( $has_featured_image ) {
+                            echo '<div class="d-flex align-items-center getpaid-form-item-has-featured-image">';
+                            echo '<div class="getpaid-form-item-image-container mr-2">';
+                            echo get_the_post_thumbnail( $item->get_id(), 'thumbnail', array( 'class' => 'getpaid-form-item-image mb-0' ) );
+                            echo '</div>';
+                            echo '<div class="getpaid-form-item-name-container">';
+                        }
 
-						echo '<div class="mb-1 font-weight-bold">' . esc_html( $item->get_name() ) . wp_kses_post( $tootip ) . '</div>';
+                        echo '<div class="mb-1 font-weight-bold">' . esc_html( $item->get_name() ) . wp_kses_post( $tootip ) . '</div>';
 
-						if ( ! empty( $description ) ) {
-							printf( '<span class="d-none d-sm-block getpaid-item-desc">%s</span>', wp_kses_post( $description ) );
-						}
+                        if ( ! empty( $description ) ) {
+                            printf( '<span class="d-none d-sm-block getpaid-item-desc">%s</span>', wp_kses_post( $description ) );
+                        }
 
-						if ( $item->allows_quantities() ) {
-							printf(
-								'<small class="d-sm-none text-muted form-text">%s</small>',
-								sprintf(
-									// translators: %s is the item quantity.
-									esc_html__( 'Qty %s', 'invoicing' ),
-									sprintf(
-										'<input
+                        if ( $item->allows_quantities() ) {
+                            printf(
+                                '<small class="d-sm-none text-muted form-text">%s</small>',
+                                sprintf(
+                                    // translators: %s is the item quantity.
+                                    esc_html__( 'Qty %s', 'invoicing' ),
+                                    sprintf(
+                                        '<input
 											type="number"
 											step="0.01"
 											style="width: 48px;"
@@ -99,62 +99,62 @@ 
 											min="1"
 											max="%s"
 										>',
-										(float) $item->get_quantity() == 0 ? 1 : (float) $item->get_quantity(),
-										floatval( null !== $max_qty ? $max_qty : 1000000000000 )
-									)
-								)
-							);
-						} else {
-							printf(
-								'<small class="d-sm-none text-muted form-text">%s</small>',
-								sprintf(
-									// translators: %s is the item quantity.
-									esc_html__( 'Qty %s', 'invoicing' ),
-									(float) $item->get_quantity()
-								)
-							);
-						}
-
-						if ( $has_featured_image ) {
-							echo '</div>';
-							echo '</div>';
-						}
-					}
-
-					// Item price.
-					if ( 'price' === $key ) {
-
-					// Set the currency position.
-					$position = wpinv_currency_position();
-
-					if ( 'left_space' === $position ) {
-						$position = 'left';
-					}
-
-					if ( 'right_space' === $position ) {
-						$position = 'right';
-					}
-
-					if ( $item->user_can_set_their_price() ) {
-						$price            = max( (float) $item->get_price(), (float) $item->get_minimum_price() );
-						$minimum          = (float) $item->get_minimum_price();
-						$validate_minimum = '';
-						$class            = '';
-						$data_minimum     = '';
-
-						if ( $minimum > 0 ) {
-							$validate_minimum = sprintf(
-								// translators: %s is the minimum price.
-								esc_attr__( 'The minimum allowed amount is %s', 'invoicing' ),
-								wp_strip_all_tags( wpinv_price( $minimum, $currency ) )
-							);
-
-							$class = 'getpaid-validate-minimum-amount';
-
-							$data_minimum     = "data-minimum-amount='" . esc_attr( getpaid_unstandardize_amount( $minimum ) ) . "'";
-						}
-
-						?>
+                                        (float) $item->get_quantity() == 0 ? 1 : (float) $item->get_quantity(),
+                                        floatval( null !== $max_qty ? $max_qty : 1000000000000 )
+                                    )
+                                )
+                            );
+                        } else {
+                            printf(
+                                '<small class="d-sm-none text-muted form-text">%s</small>',
+                                sprintf(
+                                    // translators: %s is the item quantity.
+                                    esc_html__( 'Qty %s', 'invoicing' ),
+                                    (float) $item->get_quantity()
+                                )
+                            );
+                        }
+
+                        if ( $has_featured_image ) {
+                            echo '</div>';
+                            echo '</div>';
+                        }
+                    }
+
+                    // Item price.
+                    if ( 'price' === $key ) {
+
+                    // Set the currency position.
+                    $position = wpinv_currency_position();
+
+                    if ( 'left_space' === $position ) {
+                        $position = 'left';
+                    }
+
+                    if ( 'right_space' === $position ) {
+                        $position = 'right';
+                    }
+
+                    if ( $item->user_can_set_their_price() ) {
+                        $price            = max( (float) $item->get_price(), (float) $item->get_minimum_price() );
+                        $minimum          = (float) $item->get_minimum_price();
+                        $validate_minimum = '';
+                        $class            = '';
+                        $data_minimum     = '';
+
+                        if ( $minimum > 0 ) {
+                            $validate_minimum = sprintf(
+                                // translators: %s is the minimum price.
+                                esc_attr__( 'The minimum allowed amount is %s', 'invoicing' ),
+                                wp_strip_all_tags( wpinv_price( $minimum, $currency ) )
+                            );
+
+                            $class = 'getpaid-validate-minimum-amount';
+
+                            $data_minimum     = "data-minimum-amount='" . esc_attr( getpaid_unstandardize_amount( $minimum ) ) . "'";
+                        }
+
+                        ?>
 								<div class="input-group input-group-sm">
 									<?php if ( 'left' === $position ) : ?>
 										<?php if ( empty( $GLOBALS['aui_bs5'] ) ) : ?>
@@ -195,46 +195,46 @@ 
 
 							<?php
 
-						} else {
-						?>
+                        } else {
+                        ?>
 							<span class="getpaid-items-<?php echo (int) $item->get_id(); ?>-view-price">
 								<?php echo wp_kses_post( wpinv_price( $item->get_price(), $currency ) ); ?>
 							</span>
 							<input name='getpaid-items[<?php echo (int) $item->get_id(); ?>][price]' type='hidden' class='getpaid-item-price-input' value='<?php echo esc_attr( $item->get_price() ); ?>'>
 						<?php
-						}
+                        }
 
-					printf(
+                    printf(
                         '<small class="d-sm-none text-muted form-text getpaid-mobile-item-subtotal">%s</small>',
-						// translators: %s is the item subtotal.
+                        // translators: %s is the item subtotal.
                         sprintf( esc_html__( 'Subtotal: %s', 'invoicing' ), wp_kses_post( wpinv_price( $item->get_sub_total(), $currency ) ) )
                     );
-					}
+                    }
 
-					// Item quantity.
-					if ( 'quantity' === $key ) {
+                    // Item quantity.
+                    if ( 'quantity' === $key ) {
 
-					if ( $item->allows_quantities() ) {
-						?>
+                    if ( $item->allows_quantities() ) {
+                        ?>
 								<input name='getpaid-items[<?php echo (int) $item->get_id(); ?>][quantity]' type="number" step="any" style='width: 64px; line-height: 1; min-height: 35px;' class='getpaid-item-quantity-input p-1 align-middle font-weight-normal shadow-none m-0 rounded-0 text-center border' value='<?php echo (float) $item->get_quantity() == 0 ? 1 : (float) $item->get_quantity(); ?>' min='1' <?php echo null !== $max_qty ? 'max="' . (float) $max_qty . '"' : ''; ?> required>
 						<?php
-							} else {
-						?>
+                            } else {
+                        ?>
 							<span class="getpaid-items-<?php echo (int) $item->get_id(); ?>-view-quantity">
 								<?php echo (float) $item->get_quantity(); ?>
 							</span>&nbsp;&nbsp;&nbsp;
 							<input type='hidden' name='getpaid-items[<?php echo (int) $item->get_id(); ?>][quantity]' class='getpaid-item-quantity-input' value='<?php echo (float) $item->get_quantity(); ?>'>
 						<?php
-						}
+                        }
 }
 
-					// Item sub total.
-					if ( 'subtotal' === $key ) {
-					echo wp_kses_post( wpinv_price( $item->get_sub_total(), $currency ) );
-					}
+                    // Item sub total.
+                    if ( 'subtotal' === $key ) {
+                    echo wp_kses_post( wpinv_price( $item->get_sub_total(), $currency ) );
+                    }
 
-					do_action( "getpaid_payment_form_cart_item_$key", $item, $form );
-				?>
+                    do_action( "getpaid_payment_form_cart_item_$key", $item, $form );
+                ?>
 
 			</div>
 

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

Indentation +90 added lines, -90 removed lines

@@ -12,51 +12,51 @@ 
  */
 class GetPaid_Payment_Form_Submission_Items {
 
-	/**
-	 * Submission items.
-	 * @var GetPaid_Form_Item[]
-	 */
-	public $items = array();
+    /**
+     * Submission items.
+     * @var GetPaid_Form_Item[]
+     */
+    public $items = array();
 
     /**
-	 * Class constructor
-	 *
-	 * @param GetPaid_Payment_Form_Submission $submission
-	 */
-	public function __construct( $submission ) {
-
-		$data         = $submission->get_data();
-		$payment_form = $submission->get_payment_form();
-		$invoice      = $submission->get_invoice();
-		$force_prices = array();
-
-		// Prepare the selected items.
-		$selected_items = array();
-		if ( ! empty( $data['getpaid-items'] ) ) {
-			$selected_items = wpinv_clean( $data['getpaid-items'] );
-
-			if ( ! empty( $invoice ) && $submission->is_initial_fetch() ) {
-				foreach ( $invoice->get_items() as $invoice_item ) {
-					if ( isset( $selected_items[ $invoice_item->get_id() ] ) ) {
-						$selected_items[ $invoice_item->get_id() ]['quantity'] = $invoice_item->get_quantity();
-						$selected_items[ $invoice_item->get_id() ]['price']    = $invoice_item->get_price();
-
-						$force_prices[ $invoice_item->get_id() ] = $invoice_item->get_price();
-					}
-				}
-			}
-		}
-
-		// (Maybe) set form items.
-		if ( isset( $data['getpaid-form-items'] ) ) {
-
-			// Confirm items key.
-			$form_items = wpinv_clean( $data['getpaid-form-items'] );
-			if ( ! isset( $data['getpaid-form-items-key'] ) || md5( NONCE_KEY . AUTH_KEY . $form_items ) !== $data['getpaid-form-items-key'] ) {
-				throw new Exception( __( 'We could not validate the form items. Please reload the page and try again.', 'invoicing' ) );
-			}
-
-			$items    = array();
+     * Class constructor
+     *
+     * @param GetPaid_Payment_Form_Submission $submission
+     */
+    public function __construct( $submission ) {
+
+        $data         = $submission->get_data();
+        $payment_form = $submission->get_payment_form();
+        $invoice      = $submission->get_invoice();
+        $force_prices = array();
+
+        // Prepare the selected items.
+        $selected_items = array();
+        if ( ! empty( $data['getpaid-items'] ) ) {
+            $selected_items = wpinv_clean( $data['getpaid-items'] );
+
+            if ( ! empty( $invoice ) && $submission->is_initial_fetch() ) {
+                foreach ( $invoice->get_items() as $invoice_item ) {
+                    if ( isset( $selected_items[ $invoice_item->get_id() ] ) ) {
+                        $selected_items[ $invoice_item->get_id() ]['quantity'] = $invoice_item->get_quantity();
+                        $selected_items[ $invoice_item->get_id() ]['price']    = $invoice_item->get_price();
+
+                        $force_prices[ $invoice_item->get_id() ] = $invoice_item->get_price();
+                    }
+                }
+            }
+        }
+
+        // (Maybe) set form items.
+        if ( isset( $data['getpaid-form-items'] ) ) {
+
+            // Confirm items key.
+            $form_items = wpinv_clean( $data['getpaid-form-items'] );
+            if ( ! isset( $data['getpaid-form-items-key'] ) || md5( NONCE_KEY . AUTH_KEY . $form_items ) !== $data['getpaid-form-items-key'] ) {
+                throw new Exception( __( 'We could not validate the form items. Please reload the page and try again.', 'invoicing' ) );
+            }
+
+            $items    = array();
             $item_ids = array();
 
             foreach ( getpaid_convert_items_to_array( $form_items ) as $item_id => $qty ) {
@@ -69,10 +69,10 @@ 
                         $item->set_is_required( false );
                     }
 
-					if ( ! $item->user_can_set_their_price() && isset( $force_prices[ $item_id ] ) ) {
-						$item->set_is_dynamic_pricing( true );
-						$item->set_minimum_price( 0 );
-					}
+                    if ( ! $item->user_can_set_their_price() && isset( $force_prices[ $item_id ] ) ) {
+                        $item->set_is_dynamic_pricing( true );
+                        $item->set_minimum_price( 0 );
+                    }
 
                     $item_ids[] = $item->get_id();
                     $items[]    = $item;
@@ -87,61 +87,61 @@ 
                         $items[]    = $item;
                     }
                 }
-			}
+            }
 
             $payment_form->set_items( $items );
 
-		}
-
-		// Process each individual item.
-		foreach ( $payment_form->get_items() as $item ) {
-			$this->process_item( $item, $selected_items, $submission );
-		}
-
-	}
-
-	/**
-	 * Process a single item.
-	 *
-	 * @param GetPaid_Form_Item $item
-	 * @param array $selected_items
-	 * @param GetPaid_Payment_Form_Submission $submission
-	 */
-	public function process_item( $item, $selected_items, $submission ) {
+        }
 
-		// Abort if this is an optional item and it has not been selected.
-		if ( ! $item->is_required() && ! isset( $selected_items[ $item->get_id() ] ) ) {
-			return;
-		}
+        // Process each individual item.
+        foreach ( $payment_form->get_items() as $item ) {
+            $this->process_item( $item, $selected_items, $submission );
+        }
 
-		// (maybe) let customers change the quantities and prices.
-		if ( isset( $selected_items[ $item->get_id() ] ) ) {
+    }
 
-			// Maybe change the quantities.
-			if ( $item->allows_quantities() ) {
-				$item->set_quantity( (float) $selected_items[ $item->get_id() ]['quantity'] );
-			}
+    /**
+     * Process a single item.
+     *
+     * @param GetPaid_Form_Item $item
+     * @param array $selected_items
+     * @param GetPaid_Payment_Form_Submission $submission
+     */
+    public function process_item( $item, $selected_items, $submission ) {
+
+        // Abort if this is an optional item and it has not been selected.
+        if ( ! $item->is_required() && ! isset( $selected_items[ $item->get_id() ] ) ) {
+            return;
+        }
+
+        // (maybe) let customers change the quantities and prices.
+        if ( isset( $selected_items[ $item->get_id() ] ) ) {
+
+            // Maybe change the quantities.
+            if ( $item->allows_quantities() ) {
+                $item->set_quantity( (float) $selected_items[ $item->get_id() ]['quantity'] );
+            }
 
-			// Maybe change the price.
-			if ( $item->user_can_set_their_price() ) {
-				$price = (float) wpinv_sanitize_amount( $selected_items[ $item->get_id() ]['price'] );
+            // Maybe change the price.
+            if ( $item->user_can_set_their_price() ) {
+                $price = (float) wpinv_sanitize_amount( $selected_items[ $item->get_id() ]['price'] );
 
-				if ( $item->get_minimum_price() > $price ) {
-					throw new Exception( sprintf( __( 'The minimum allowed amount is %s', 'invoicing' ), getpaid_unstandardize_amount( $item->get_minimum_price() ) ) );
-				}
+                if ( $item->get_minimum_price() > $price ) {
+                    throw new Exception( sprintf( __( 'The minimum allowed amount is %s', 'invoicing' ), getpaid_unstandardize_amount( $item->get_minimum_price() ) ) );
+                }
 
-				$item->set_price( $price );
+                $item->set_price( $price );
 
-			}
-		}
+            }
+        }
 
-		if ( 0 == $item->get_quantity() ) {
-			return;
-		}
+        if ( 0 == $item->get_quantity() ) {
+            return;
+        }
 
-		// Save the item.
-		$this->items[] = apply_filters( 'getpaid_payment_form_submission_processed_item', $item, $submission );
+        // Save the item.
+        $this->items[] = apply_filters( 'getpaid_payment_form_submission_processed_item', $item, $submission );
 
-	}
+    }
 
 }

includes/payments/class-getpaid-payment-form-submission-refresh-prices.php

Indentation +271 added lines, -271 removed lines

@@ -12,305 +12,305 @@
  */
 class GetPaid_Payment_Form_Submission_Refresh_Prices {
 
-	/**
-	 * Contains the response for refreshing prices.
-	 * @var array
-	 */
-	public $response = array();
+    /**
+     * Contains the response for refreshing prices.
+     * @var array
+     */
+    public $response = array();
 
     /**
-	 * Class constructor
-	 *
-	 * @param GetPaid_Payment_Form_Submission $submission
-	 */
-	public function __construct( $submission ) {
-
-		$this->response = array(
-			'submission_id'                    => $submission->id,
+     * Class constructor
+     *
+     * @param GetPaid_Payment_Form_Submission $submission
+     */
+    public function __construct( $submission ) {
+
+        $this->response = array(
+            'submission_id'                    => $submission->id,
             'has_recurring'                    => $submission->has_recurring,
-			'has_subscription_group'           => $submission->has_subscription_group(),
-			'has_multiple_subscription_groups' => $submission->has_multiple_subscription_groups(),
+            'has_subscription_group'           => $submission->has_subscription_group(),
+            'has_multiple_subscription_groups' => $submission->has_multiple_subscription_groups(),
             'is_free'                          => ! $submission->should_collect_payment_details(),
-		);
-
-		$payment_form = $submission->get_payment_form();
-		if ( ! empty( $payment_form->invoice ) ) {
-			$this->response['invoice'] = $payment_form->invoice->get_id();
-		}
-
-		$this->add_totals( $submission );
-		$this->add_texts( $submission );
-		$this->add_items( $submission );
-		$this->add_fees( $submission );
-		$this->add_discounts( $submission );
-		$this->add_taxes( $submission );
-		$this->add_gateways( $submission );
-		$this->add_data( $submission );
-
-	}
-
-	/**
-	 * Adds totals to a response for submission refresh prices.
-	 *
-	 * @param GetPaid_Payment_Form_Submission $submission
-	 */
-	public function add_totals( $submission ) {
-
-		$this->response = array_merge(
-			$this->response,
-			array(
-
-				'totals'      => array(
-					'subtotal'  => $submission->format_amount( $submission->get_subtotal() ),
-					'discount'  => $submission->format_amount( $submission->get_discount() ),
-					'fees'      => $submission->format_amount( $submission->get_fee() ),
-					'tax'       => $submission->format_amount( $submission->get_tax() ),
-					'total'     => $submission->format_amount( $submission->get_total() ),
-					'raw_total' => html_entity_decode( sanitize_text_field( $submission->format_amount( $submission->get_total() ) ), ENT_QUOTES ),
-				),
-
-				'recurring'   => array(
-					'subtotal' => $submission->format_amount( $submission->get_recurring_subtotal() ),
-					'discount' => $submission->format_amount( $submission->get_recurring_discount() ),
-					'fees'     => $submission->format_amount( $submission->get_recurring_fee() ),
-					'tax'      => $submission->format_amount( $submission->get_recurring_tax() ),
-					'total'    => $submission->format_amount( $submission->get_recurring_total() ),
-				),
-
-				'initial_amt' => wpinv_round_amount( $submission->get_total(), null, true ),
-				'currency'    => $submission->get_currency(),
-
-			)
-		);
-
-	}
-
-	/**
-	 * Adds texts to a response for submission refresh prices.
-	 *
-	 * @param GetPaid_Payment_Form_Submission $submission
-	 */
-	public function add_texts( $submission ) {
-
-		$payable = $submission->format_amount( $submission->get_total() );
-		$groups  = getpaid_get_subscription_groups( $submission );
-
-		if ( $submission->has_recurring && 2 > count( $groups ) ) {
-
-			$recurring = new WPInv_Item( $submission->has_recurring );
-			$period    = getpaid_get_subscription_period_label( $recurring->get_recurring_period( true ), $recurring->get_recurring_interval(), '' );
-			$main_item = reset( $groups );
-
-			if ( $submission->get_total() == $submission->get_recurring_total() ) {
-				$payable = "$payable / $period";
-			} elseif ( $main_item ) {
-
-				$main_item = reset( $main_item );
-
-				// Calculate the next renewal date.
-				$_period      = $main_item->get_recurring_period( true );
-				$_interval    = $main_item->get_recurring_interval();
-
-				// If the subscription item has a trial period...
-				if ( $main_item->has_free_trial() ) {
-					$_period   = $main_item->get_trial_period( true );
-					$_interval = $main_item->get_trial_interval();
-				}
-
-				$payable = sprintf(
-					__( '%1$s (renews at %2$s / %3$s)', 'invoicing' ),
-					$submission->format_amount( $submission->get_total() ),
-					$submission->format_amount( $submission->get_recurring_total() ),
-					$period
-				);
-
-				$payable .= sprintf(
-					'<small class="text-muted form-text">%s</small>',
-					sprintf(
-						__( 'First renewal on %s', 'invoicing' ),
-						getpaid_format_date( date( 'Y-m-d H:i:s', strtotime( "+$_interval $_period", current_time( 'timestamp' ) ) ) )
-					)
-				);
-
-			} else {
-				$payable = sprintf(
-					__( '%1$s (renews at %2$s / %3$s)', 'invoicing' ),
-					$submission->format_amount( $submission->get_total() ),
-					$submission->format_amount( $submission->get_recurring_total() ),
-					$period
-				);
-			}
-}
+        );
+
+        $payment_form = $submission->get_payment_form();
+        if ( ! empty( $payment_form->invoice ) ) {
+            $this->response['invoice'] = $payment_form->invoice->get_id();
+        }
+
+        $this->add_totals( $submission );
+        $this->add_texts( $submission );
+        $this->add_items( $submission );
+        $this->add_fees( $submission );
+        $this->add_discounts( $submission );
+        $this->add_taxes( $submission );
+        $this->add_gateways( $submission );
+        $this->add_data( $submission );
 
-		$texts = array(
-			'.getpaid-checkout-total-payable' => $payable,
-		);
+    }
 
-		foreach ( $submission->get_items() as $item ) {
-			$item_id                                               = $item->get_id();
-			$initial_price                                         = $submission->format_amount( $item->get_sub_total() - $item->item_discount );
-			$recurring_price                                       = $submission->format_amount( $item->get_recurring_sub_total() - $item->recurring_item_discount );
-			$texts[ ".item-$item_id .getpaid-form-item-price-desc" ] = getpaid_item_recurring_price_help_text( $item, $submission->get_currency(), $initial_price, $recurring_price );
-			$texts[ ".item-$item_id .getpaid-mobile-item-subtotal" ] = sprintf( __( 'Subtotal: %s', 'invoicing' ), $submission->format_amount( $item->get_sub_total() ) );
+    /**
+     * Adds totals to a response for submission refresh prices.
+     *
+     * @param GetPaid_Payment_Form_Submission $submission
+     */
+    public function add_totals( $submission ) {
+
+        $this->response = array_merge(
+            $this->response,
+            array(
+
+                'totals'      => array(
+                    'subtotal'  => $submission->format_amount( $submission->get_subtotal() ),
+                    'discount'  => $submission->format_amount( $submission->get_discount() ),
+                    'fees'      => $submission->format_amount( $submission->get_fee() ),
+                    'tax'       => $submission->format_amount( $submission->get_tax() ),
+                    'total'     => $submission->format_amount( $submission->get_total() ),
+                    'raw_total' => html_entity_decode( sanitize_text_field( $submission->format_amount( $submission->get_total() ) ), ENT_QUOTES ),
+                ),
+
+                'recurring'   => array(
+                    'subtotal' => $submission->format_amount( $submission->get_recurring_subtotal() ),
+                    'discount' => $submission->format_amount( $submission->get_recurring_discount() ),
+                    'fees'     => $submission->format_amount( $submission->get_recurring_fee() ),
+                    'tax'      => $submission->format_amount( $submission->get_recurring_tax() ),
+                    'total'    => $submission->format_amount( $submission->get_recurring_total() ),
+                ),
+
+                'initial_amt' => wpinv_round_amount( $submission->get_total(), null, true ),
+                'currency'    => $submission->get_currency(),
+
+            )
+        );
+
+    }
 
-			if ( $item->get_quantity() == 1 ) {
-				$texts[ ".item-$item_id .getpaid-mobile-item-subtotal" ] = '';
-			}
+    /**
+     * Adds texts to a response for submission refresh prices.
+     *
+     * @param GetPaid_Payment_Form_Submission $submission
+     */
+    public function add_texts( $submission ) {
+
+        $payable = $submission->format_amount( $submission->get_total() );
+        $groups  = getpaid_get_subscription_groups( $submission );
+
+        if ( $submission->has_recurring && 2 > count( $groups ) ) {
+
+            $recurring = new WPInv_Item( $submission->has_recurring );
+            $period    = getpaid_get_subscription_period_label( $recurring->get_recurring_period( true ), $recurring->get_recurring_interval(), '' );
+            $main_item = reset( $groups );
+
+            if ( $submission->get_total() == $submission->get_recurring_total() ) {
+                $payable = "$payable / $period";
+            } elseif ( $main_item ) {
+
+                $main_item = reset( $main_item );
+
+                // Calculate the next renewal date.
+                $_period      = $main_item->get_recurring_period( true );
+                $_interval    = $main_item->get_recurring_interval();
+
+                // If the subscription item has a trial period...
+                if ( $main_item->has_free_trial() ) {
+                    $_period   = $main_item->get_trial_period( true );
+                    $_interval = $main_item->get_trial_interval();
+                }
+
+                $payable = sprintf(
+                    __( '%1$s (renews at %2$s / %3$s)', 'invoicing' ),
+                    $submission->format_amount( $submission->get_total() ),
+                    $submission->format_amount( $submission->get_recurring_total() ),
+                    $period
+                );
+
+                $payable .= sprintf(
+                    '<small class="text-muted form-text">%s</small>',
+                    sprintf(
+                        __( 'First renewal on %s', 'invoicing' ),
+                        getpaid_format_date( date( 'Y-m-d H:i:s', strtotime( "+$_interval $_period", current_time( 'timestamp' ) ) ) )
+                    )
+                );
+
+            } else {
+                $payable = sprintf(
+                    __( '%1$s (renews at %2$s / %3$s)', 'invoicing' ),
+                    $submission->format_amount( $submission->get_total() ),
+                    $submission->format_amount( $submission->get_recurring_total() ),
+                    $period
+                );
+            }
 }
 
-		$this->response = array_merge( $this->response, array( 'texts' => $texts ) );
+        $texts = array(
+            '.getpaid-checkout-total-payable' => $payable,
+        );
 
-	}
+        foreach ( $submission->get_items() as $item ) {
+            $item_id                                               = $item->get_id();
+            $initial_price                                         = $submission->format_amount( $item->get_sub_total() - $item->item_discount );
+            $recurring_price                                       = $submission->format_amount( $item->get_recurring_sub_total() - $item->recurring_item_discount );
+            $texts[ ".item-$item_id .getpaid-form-item-price-desc" ] = getpaid_item_recurring_price_help_text( $item, $submission->get_currency(), $initial_price, $recurring_price );
+            $texts[ ".item-$item_id .getpaid-mobile-item-subtotal" ] = sprintf( __( 'Subtotal: %s', 'invoicing' ), $submission->format_amount( $item->get_sub_total() ) );
+
+            if ( $item->get_quantity() == 1 ) {
+                $texts[ ".item-$item_id .getpaid-mobile-item-subtotal" ] = '';
+            }
+}
 
-	/**
-	 * Adds items to a response for submission refresh prices.
-	 *
-	 * @param GetPaid_Payment_Form_Submission $submission
-	 */
-	public function add_items( $submission ) {
+        $this->response = array_merge( $this->response, array( 'texts' => $texts ) );
 
-		// Add items.
-		$items          = array();
-		$selected_items = array();
+    }
+
+    /**
+     * Adds items to a response for submission refresh prices.
+     *
+     * @param GetPaid_Payment_Form_Submission $submission
+     */
+    public function add_items( $submission ) {
+
+        // Add items.
+        $items          = array();
+        $selected_items = array();
 
         foreach ( $submission->get_items() as $item ) {
-			$item_id             = $item->get_id();
-			$items[ "$item_id" ] = $submission->format_amount( $item->get_sub_total() );
-
-			$selected_items[ "$item_id" ] = array(
-				'quantity'  => $item->get_quantity(),
-				'price'     => $item->get_price(),
-				'price_fmt' => $submission->format_amount( $item->get_price() ),
-			);
-		}
-
-		$this->response = array_merge(
-			$this->response,
-			array(
-				'items'          => $items,
-				'selected_items' => $selected_items,
-			)
-		);
-
-	}
-
-	/**
-	 * Adds fees to a response for submission refresh prices.
-	 *
-	 * @param GetPaid_Payment_Form_Submission $submission
-	 */
-	public function add_fees( $submission ) {
-
-		$fees = array();
+            $item_id             = $item->get_id();
+            $items[ "$item_id" ] = $submission->format_amount( $item->get_sub_total() );
+
+            $selected_items[ "$item_id" ] = array(
+                'quantity'  => $item->get_quantity(),
+                'price'     => $item->get_price(),
+                'price_fmt' => $submission->format_amount( $item->get_price() ),
+            );
+        }
+
+        $this->response = array_merge(
+            $this->response,
+            array(
+                'items'          => $items,
+                'selected_items' => $selected_items,
+            )
+        );
+
+    }
+
+    /**
+     * Adds fees to a response for submission refresh prices.
+     *
+     * @param GetPaid_Payment_Form_Submission $submission
+     */
+    public function add_fees( $submission ) {
+
+        $fees = array();
 
         foreach ( $submission->get_fees() as $name => $data ) {
-			$fees[ $name ] = $submission->format_amount( $data['initial_fee'] );
-		}
+            $fees[ $name ] = $submission->format_amount( $data['initial_fee'] );
+        }
 
-		$this->response = array_merge(
-			$this->response,
-			array( 'fees' => $fees )
-		);
+        $this->response = array_merge(
+            $this->response,
+            array( 'fees' => $fees )
+        );
 
-	}
+    }
 
-	/**
-	 * Adds discounts to a response for submission refresh prices.
-	 *
-	 * @param GetPaid_Payment_Form_Submission $submission
-	 */
-	public function add_discounts( $submission ) {
+    /**
+     * Adds discounts to a response for submission refresh prices.
+     *
+     * @param GetPaid_Payment_Form_Submission $submission
+     */
+    public function add_discounts( $submission ) {
 
-		$discounts = array();
+        $discounts = array();
 
         foreach ( $submission->get_discounts() as $name => $data ) {
-			$discounts[ $name ] = $submission->format_amount( $data['initial_discount'] );
-		}
+            $discounts[ $name ] = $submission->format_amount( $data['initial_discount'] );
+        }
 
-		$this->response = array_merge(
-			$this->response,
-			array( 'discounts' => $discounts )
-		);
+        $this->response = array_merge(
+            $this->response,
+            array( 'discounts' => $discounts )
+        );
 
-	}
+    }
 
-	/**
-	 * Adds taxes to a response for submission refresh prices.
-	 *
-	 * @param GetPaid_Payment_Form_Submission $submission
-	 */
-	public function add_taxes( $submission ) {
-
-		$taxes  = array();
-		$markup = '';
+    /**
+     * Adds taxes to a response for submission refresh prices.
+     *
+     * @param GetPaid_Payment_Form_Submission $submission
+     */
+    public function add_taxes( $submission ) {
+
+        $taxes  = array();
+        $markup = '';
         foreach ( $submission->get_taxes() as $name => $data ) {
-			$name          = sanitize_text_field( $name );
-			$amount        = $submission->format_amount( $data['initial_tax'] );
-			$taxes[ $name ]  = $amount;
-			$markup       .= "<small class='form-text'>$name : $amount</small>";
-		}
-
-		if ( wpinv_display_individual_tax_rates() && ! empty( $taxes ) ) {
-			$this->response['texts']['.getpaid-form-cart-totals-total-tax'] = $markup;
-		}
-
-		$this->response = array_merge(
-			$this->response,
-			array( 'taxes' => $taxes )
-		);
-
-	}
-
-	/**
-	 * Adds gateways to a response for submission refresh prices.
-	 *
-	 * @param GetPaid_Payment_Form_Submission $submission
-	 */
-	public function add_gateways( $submission ) {
-
-		$gateways = array_keys( wpinv_get_enabled_payment_gateways() );
-
-		if ( $this->response['has_recurring'] ) {
-
-			foreach ( $gateways as $i => $gateway ) {
-
-				if (
-					! getpaid_payment_gateway_supports( $gateway, 'subscription' )
-					|| ( $this->response['has_subscription_group'] && ! getpaid_payment_gateway_supports( $gateway, 'single_subscription_group' ) )
-					|| ( $this->response['has_multiple_subscription_groups'] && ! getpaid_payment_gateway_supports( $gateway, 'multiple_subscription_groups' ) ) ) {
-					unset( $gateways[ $i ] );
-				}
+            $name          = sanitize_text_field( $name );
+            $amount        = $submission->format_amount( $data['initial_tax'] );
+            $taxes[ $name ]  = $amount;
+            $markup       .= "<small class='form-text'>$name : $amount</small>";
+        }
+
+        if ( wpinv_display_individual_tax_rates() && ! empty( $taxes ) ) {
+            $this->response['texts']['.getpaid-form-cart-totals-total-tax'] = $markup;
+        }
+
+        $this->response = array_merge(
+            $this->response,
+            array( 'taxes' => $taxes )
+        );
+
+    }
+
+    /**
+     * Adds gateways to a response for submission refresh prices.
+     *
+     * @param GetPaid_Payment_Form_Submission $submission
+     */
+    public function add_gateways( $submission ) {
+
+        $gateways = array_keys( wpinv_get_enabled_payment_gateways() );
+
+        if ( $this->response['has_recurring'] ) {
+
+            foreach ( $gateways as $i => $gateway ) {
+
+                if (
+                    ! getpaid_payment_gateway_supports( $gateway, 'subscription' )
+                    || ( $this->response['has_subscription_group'] && ! getpaid_payment_gateway_supports( $gateway, 'single_subscription_group' ) )
+                    || ( $this->response['has_multiple_subscription_groups'] && ! getpaid_payment_gateway_supports( $gateway, 'multiple_subscription_groups' ) ) ) {
+                    unset( $gateways[ $i ] );
+                }
 }
 }
 
-		$gateways = apply_filters( 'getpaid_submission_gateways', $gateways, $submission );
-		$this->response = array_merge(
-			$this->response,
-			array( 'gateways' => $gateways )
-		);
-
-	}
-
-	/**
-	 * Adds data to a response for submission refresh prices.
-	 *
-	 * @param GetPaid_Payment_Form_Submission $submission
-	 */
-	public function add_data( $submission ) {
-
-		$this->response = array_merge(
-			$this->response,
-			array(
-				'js_data' => apply_filters(
-					'getpaid_submission_js_data',
-					array(
-						'is_recurring' => $this->response['has_recurring'],
-					),
-					$submission
-				),
-			)
-		);
-
-	}
+        $gateways = apply_filters( 'getpaid_submission_gateways', $gateways, $submission );
+        $this->response = array_merge(
+            $this->response,
+            array( 'gateways' => $gateways )
+        );
+
+    }
+
+    /**
+     * Adds data to a response for submission refresh prices.
+     *
+     * @param GetPaid_Payment_Form_Submission $submission
+     */
+    public function add_data( $submission ) {
+
+        $this->response = array_merge(
+            $this->response,
+            array(
+                'js_data' => apply_filters(
+                    'getpaid_submission_js_data',
+                    array(
+                        'is_recurring' => $this->response['has_recurring'],
+                    ),
+                    $submission
+                ),
+            )
+        );
+
+    }
 
 }

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

Indentation +359 added lines, -359 removed lines

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

invoicing.php

Indentation +4 added lines, -4 removed lines

@@ -19,16 +19,16 @@ 
 
 // Define constants.
 if ( ! defined( 'WPINV_PLUGIN_FILE' ) ) {
-	define( 'WPINV_PLUGIN_FILE', __FILE__ );
+    define( 'WPINV_PLUGIN_FILE', __FILE__ );
 }
 
 if ( ! defined( 'WPINV_VERSION' ) ) {
-	define( 'WPINV_VERSION', '2.7.0' );
+    define( 'WPINV_VERSION', '2.7.0' );
 }
 
 // Include the main Invoicing class.
 if ( ! class_exists( 'WPInv_Plugin', false ) ) {
-	require_once plugin_dir_path( WPINV_PLUGIN_FILE ) . 'includes/class-wpinv.php';
+    require_once plugin_dir_path( WPINV_PLUGIN_FILE ) . 'includes/class-wpinv.php';
 }
 
 /**
@@ -43,7 +43,7 @@ 
         $GLOBALS['invoicing'] = new WPInv_Plugin();
     }
 
-	return $GLOBALS['invoicing'];
+    return $GLOBALS['invoicing'];
 }
 
 /**

vendor/ayecode/wp-font-awesome-settings/wp-font-awesome-settings.php

Indentation +763 added lines, -763 removed lines

@@ -13,7 +13,7 @@ 
  * Bail if we are not in WP.
  */
 if ( ! defined( 'ABSPATH' ) ) {
-	exit;
+    exit;
 }
 
 /**
@@ -21,362 +21,362 @@ 
  */
 if ( ! class_exists( 'WP_Font_Awesome_Settings' ) ) {
 
-	/**
-	 * A Class to be able to change settings for Font Awesome.
-	 *
-	 * Class WP_Font_Awesome_Settings
-	 * @since 1.0.10 Now able to pass wp.org theme check.
-	 * @since 1.0.11 Font Awesome Pro now supported.
-	 * @since 1.0.11 Font Awesome Kits now supported.
-	 * @since 1.0.13 RTL language support added.
-	 * @since 1.0.14 Warning added for v6 pro requires kit and will now not work if official FA plugin installed.
-	 * @since 1.0.15 Font Awesome will now load in the FSE if enable din the backend.
-	 * @since 1.1.0 Option added to load FontAwesome locally.
-	 * @since 1.1.1 Requires to re-save settings to load locally when option does not exists - FIXED.
-	 * @since 1.1.2 Bumped the latest version to 6.3.0 - CHANGED.
-	 * @ver 1.0.15
-	 * @todo decide how to implement textdomain
-	 */
-	class WP_Font_Awesome_Settings {
-
-		/**
-		 * Class version version.
-		 *
-		 * @var string
-		 */
-		public $version = '1.1.2';
-
-		/**
-		 * Class textdomain.
-		 *
-		 * @var string
-		 */
-		public $textdomain = 'font-awesome-settings';
-
-		/**
-		 * Latest version of Font Awesome at time of publish published.
-		 *
-		 * @var string
-		 */
-		public $latest = "6.3.0";
-
-		/**
-		 * The title.
-		 *
-		 * @var string
-		 */
-		public $name = 'Font Awesome';
-
-		/**
-		 * Holds the settings values.
-		 *
-		 * @var array
-		 */
-		private $settings;
-
-		/**
-		 * WP_Font_Awesome_Settings instance.
-		 *
-		 * @access private
-		 * @since  1.0.0
-		 * @var    WP_Font_Awesome_Settings There can be only one!
-		 */
-		private static $instance = null;
-
-		/**
-		 * Main WP_Font_Awesome_Settings Instance.
-		 *
-		 * Ensures only one instance of WP_Font_Awesome_Settings is loaded or can be loaded.
-		 *
-		 * @since 1.0.0
-		 * @static
-		 * @return WP_Font_Awesome_Settings - Main instance.
-		 */
-		public static function instance() {
-			if ( ! isset( self::$instance ) && ! ( self::$instance instanceof WP_Font_Awesome_Settings ) ) {
-				self::$instance = new WP_Font_Awesome_Settings;
-
-				add_action( 'init', array( self::$instance, 'init' ) ); // set settings
-
-				if ( is_admin() ) {
-					add_action( 'admin_menu', array( self::$instance, 'menu_item' ) );
-					add_action( 'admin_init', array( self::$instance, 'register_settings' ) );
-					add_action( 'admin_notices', array( self::$instance, 'admin_notices' ) );
-				}
-
-				do_action( 'wp_font_awesome_settings_loaded' );
-			}
-
-			return self::$instance;
-		}
-
-		/**
-		 * Initiate the settings and add the required action hooks.
-		 *
-		 * @since 1.0.8 Settings name wrong - FIXED
-		 */
-		public function init() {
-			// Download fontawesome locally.
-			add_action( 'add_option_wp-font-awesome-settings', array( $this, 'add_option_wp_font_awesome_settings' ), 10, 2 );
-			add_action( 'update_option_wp-font-awesome-settings', array( $this, 'update_option_wp_font_awesome_settings' ), 10, 2 );
-
-			$this->settings = $this->get_settings();
-
-			// check if the official plugin is active and use that instead if so.
-			if ( ! defined( 'FONTAWESOME_PLUGIN_FILE' ) ) {
-
-				if ( $this->settings['type'] == 'CSS' ) {
-
-					if ( $this->settings['enqueue'] == '' || $this->settings['enqueue'] == 'frontend' ) {
-						add_action( 'wp_enqueue_scripts', array( $this, 'enqueue_style' ), 5000 );
-					}
-
-					if ( $this->settings['enqueue'] == '' || $this->settings['enqueue'] == 'backend' ) {
-						add_action( 'admin_enqueue_scripts', array( $this, 'enqueue_style' ), 5000 );
-						add_filter( 'block_editor_settings_all', array( $this, 'enqueue_editor_styles' ), 10, 2 );
-					}
-
-				} else {
-
-					if ( $this->settings['enqueue'] == '' || $this->settings['enqueue'] == 'frontend' ) {
-						add_action( 'wp_enqueue_scripts', array( $this, 'enqueue_scripts' ), 5000 );
-					}
-
-					if ( $this->settings['enqueue'] == '' || $this->settings['enqueue'] == 'backend' ) {
-						add_action( 'admin_enqueue_scripts', array( $this, 'enqueue_scripts' ), 5000 );
-						add_filter( 'block_editor_settings_all', array( $this, 'enqueue_editor_scripts' ), 10, 2 );
-					}
-				}
-
-				// remove font awesome if set to do so
-				if ( $this->settings['dequeue'] == '1' ) {
-					add_action( 'clean_url', array( $this, 'remove_font_awesome' ), 5000, 3 );
-				}
-			}
-
-		}
-
-		/**
-		 * Add FA to the FSE.
-		 *
-		 * @param $editor_settings
-		 * @param $block_editor_context
-		 *
-		 * @return array
-		 */
-		public function enqueue_editor_styles( $editor_settings, $block_editor_context ){
-
-			if ( ! empty( $editor_settings['__unstableResolvedAssets']['styles'] ) ) {
-				$url = $this->get_url();
-				$editor_settings['__unstableResolvedAssets']['styles'] .= "<link rel='stylesheet' id='font-awesome-css'  href='$url' media='all' />";
-			}
-
-			return $editor_settings;
-		}
-
-		/**
-		 * Add FA to the FSE.
-		 *
-		 * @param $editor_settings
-		 * @param $block_editor_context
-		 *
-		 * @return array
-		 */
-		public function enqueue_editor_scripts( $editor_settings, $block_editor_context ){
-
-			$url = $this->get_url();
-			$editor_settings['__unstableResolvedAssets']['scripts'] .= "<script src='$url' id='font-awesome-js'></script>";
-
-			return $editor_settings;
-		}
-
-		/**
-		 * Adds the Font Awesome styles.
-		 */
-		public function enqueue_style() {
-			// build url
-			$url = $this->get_url();
-			$version = ! empty( $this->settings['local'] ) && empty( $this->settings['pro'] ) ? strip_tags( $this->settings['local_version'] ) : null;
-
-			wp_deregister_style( 'font-awesome' ); // deregister in case its already there
-			wp_register_style( 'font-awesome', $url, array(), $version );
-			wp_enqueue_style( 'font-awesome' );
-
-			// RTL language support CSS.
-			if ( is_rtl() ) {
-				wp_add_inline_style( 'font-awesome', $this->rtl_inline_css() );
-			}
-
-			if ( $this->settings['shims'] ) {
-				$url = $this->get_url( true );
-				wp_deregister_style( 'font-awesome-shims' ); // deregister in case its already there
-				wp_register_style( 'font-awesome-shims', $url, array(), $version );
-				wp_enqueue_style( 'font-awesome-shims' );
-			}
-		}
-
-		/**
-		 * Adds the Font Awesome JS.
-		 */
-		public function enqueue_scripts() {
-			// build url
-			$url = $this->get_url();
-
-			$deregister_function = 'wp' . '_' . 'deregister' . '_' . 'script';
-			call_user_func( $deregister_function, 'font-awesome' ); // deregister in case its already there
-			wp_register_script( 'font-awesome', $url, array(), null );
-			wp_enqueue_script( 'font-awesome' );
-
-			if ( $this->settings['shims'] ) {
-				$url = $this->get_url( true );
-				call_user_func( $deregister_function, 'font-awesome-shims' ); // deregister in case its already there
-				wp_register_script( 'font-awesome-shims', $url, array(), null );
-				wp_enqueue_script( 'font-awesome-shims' );
-			}
-		}
-
-		/**
-		 * Get the url of the Font Awesome files.
-		 *
-		 * @param bool $shims If this is a shim file or not.
-		 * @param bool $local Load locally if allowed.
-		 *
-		 * @return string The url to the file.
-		 */
-		public function get_url( $shims = false, $local = true ) {
-			$script  = $shims ? 'v4-shims' : 'all';
-			$sub     = $this->settings['pro'] ? 'pro' : 'use';
-			$type    = $this->settings['type'];
-			$version = $this->settings['version'];
-			$kit_url = $this->settings['kit-url'] ? esc_url( $this->settings['kit-url'] ) : '';
-			$url     = '';
-
-			if ( $type == 'KIT' && $kit_url ) {
-				if ( $shims ) {
-					// if its a kit then we don't add shims here
-					return '';
-				}
-				$url .= $kit_url; // CDN
-				$url .= "?wpfas=true"; // set our var so our version is not removed
-			} else {
-				$v = '';
-				// Check and load locally.
-				if ( $local && $this->has_local() ) {
-					$script .= ".min";
-					$v .= '&ver=' . strip_tags( $this->settings['local_version'] );
-					$url .= $this->get_fonts_url(); // Local fonts url.
-				} else {
-					$url .= "https://$sub.fontawesome.com/releases/"; // CDN
-					$url .= ! empty( $version ) ? "v" . $version . '/' : "v" . $this->get_latest_version() . '/'; // version
-				}
-				$url .= $type == 'CSS' ? 'css/' : 'js/'; // type
-				$url .= $type == 'CSS' ? $script . '.css' : $script . '.js'; // type
-				$url .= "?wpfas=true" . $v; // set our var so our version is not removed
-			}
-
-			return $url;
-		}
-
-		/**
-		 * Try and remove any other versions of Font Awesome added by other plugins/themes.
-		 *
-		 * Uses the clean_url filter to try and remove any other Font Awesome files added, it can also add pseudo-elements flag for the JS version.
-		 *
-		 * @param $url
-		 * @param $original_url
-		 * @param $_context
-		 *
-		 * @return string The filtered url.
-		 */
-		public function remove_font_awesome( $url, $original_url, $_context ) {
-
-			if ( $_context == 'display'
-			     && ( strstr( $url, "fontawesome" ) !== false || strstr( $url, "font-awesome" ) !== false )
-			     && ( strstr( $url, ".js" ) !== false || strstr( $url, ".css" ) !== false )
-			) {// it's a font-awesome-url (probably)
-
-				if ( strstr( $url, "wpfas=true" ) !== false ) {
-					if ( $this->settings['type'] == 'JS' ) {
-						if ( $this->settings['js-pseudo'] ) {
-							$url .= "' data-search-pseudo-elements defer='defer";
-						} else {
-							$url .= "' defer='defer";
-						}
-					}
-				} else {
-					$url = ''; // removing the url removes the file
-				}
-
-			}
-
-			return $url;
-		}
-
-		/**
-		 * Register the database settings with WordPress.
-		 */
-		public function register_settings() {
-			register_setting( 'wp-font-awesome-settings', 'wp-font-awesome-settings' );
-		}
-
-		/**
-		 * Add the WordPress settings menu item.
-		 * @since 1.0.10 Calling function name direct will fail theme check so we don't.
-		 */
-		public function menu_item() {
-			$menu_function = 'add' . '_' . 'options' . '_' . 'page'; // won't pass theme check if function name present in theme
-			call_user_func( $menu_function, $this->name, $this->name, 'manage_options', 'wp-font-awesome-settings', array(
-				$this,
-				'settings_page'
-			) );
-		}
-
-		/**
-		 * Get the current Font Awesome output settings.
-		 *
-		 * @return array The array of settings.
-		 */
-		public function get_settings() {
-			$db_settings = get_option( 'wp-font-awesome-settings' );
-
-			$defaults = array(
-				'type'      => 'CSS', // type to use, CSS or JS or KIT
-				'version'   => '', // latest
-				'enqueue'   => '', // front and backend
-				'shims'     => '0', // default OFF now in 2020
-				'js-pseudo' => '0', // if the pseudo elements flag should be set (CPU intensive)
-				'dequeue'   => '0', // if we should try to remove other versions added by other plugins/themes
-				'pro'       => '0', // if pro CDN url should be used
-				'local'     => '0', // Store fonts locally.
-				'local_version' => '', // Local fonts version.
-				'kit-url'   => '', // the kit url
-			);
-
-			$settings = wp_parse_args( $db_settings, $defaults );
-
-			/**
-			 * Filter the Font Awesome settings.
-			 *
-			 * @todo if we add this filer people might use it and then it defeates the purpose of this class :/
-			 */
-			return $this->settings = apply_filters( 'wp-font-awesome-settings', $settings, $db_settings, $defaults );
-		}
-
-		/**
-		 * The settings page html output.
-		 */
-		public function settings_page() {
-			if ( ! current_user_can( 'manage_options' ) ) {
-				wp_die( __( 'You do not have sufficient permissions to access this page.', 'font-awesome-settings' ) );
-			}
-
-			// a hidden way to force the update of the version number via api instead of waiting the 48 hours
-			if ( isset( $_REQUEST['force-version-check'] ) ) {
-				$this->get_latest_version( $force_api = true );
-			}
-
-			if ( ! defined( 'FONTAWESOME_PLUGIN_FILE' ) ) {
-				?>
+    /**
+     * A Class to be able to change settings for Font Awesome.
+     *
+     * Class WP_Font_Awesome_Settings
+     * @since 1.0.10 Now able to pass wp.org theme check.
+     * @since 1.0.11 Font Awesome Pro now supported.
+     * @since 1.0.11 Font Awesome Kits now supported.
+     * @since 1.0.13 RTL language support added.
+     * @since 1.0.14 Warning added for v6 pro requires kit and will now not work if official FA plugin installed.
+     * @since 1.0.15 Font Awesome will now load in the FSE if enable din the backend.
+     * @since 1.1.0 Option added to load FontAwesome locally.
+     * @since 1.1.1 Requires to re-save settings to load locally when option does not exists - FIXED.
+     * @since 1.1.2 Bumped the latest version to 6.3.0 - CHANGED.
+     * @ver 1.0.15
+     * @todo decide how to implement textdomain
+     */
+    class WP_Font_Awesome_Settings {
+
+        /**
+         * Class version version.
+         *
+         * @var string
+         */
+        public $version = '1.1.2';
+
+        /**
+         * Class textdomain.
+         *
+         * @var string
+         */
+        public $textdomain = 'font-awesome-settings';
+
+        /**
+         * Latest version of Font Awesome at time of publish published.
+         *
+         * @var string
+         */
+        public $latest = "6.3.0";
+
+        /**
+         * The title.
+         *
+         * @var string
+         */
+        public $name = 'Font Awesome';
+
+        /**
+         * Holds the settings values.
+         *
+         * @var array
+         */
+        private $settings;
+
+        /**
+         * WP_Font_Awesome_Settings instance.
+         *
+         * @access private
+         * @since  1.0.0
+         * @var    WP_Font_Awesome_Settings There can be only one!
+         */
+        private static $instance = null;
+
+        /**
+         * Main WP_Font_Awesome_Settings Instance.
+         *
+         * Ensures only one instance of WP_Font_Awesome_Settings is loaded or can be loaded.
+         *
+         * @since 1.0.0
+         * @static
+         * @return WP_Font_Awesome_Settings - Main instance.
+         */
+        public static function instance() {
+            if ( ! isset( self::$instance ) && ! ( self::$instance instanceof WP_Font_Awesome_Settings ) ) {
+                self::$instance = new WP_Font_Awesome_Settings;
+
+                add_action( 'init', array( self::$instance, 'init' ) ); // set settings
+
+                if ( is_admin() ) {
+                    add_action( 'admin_menu', array( self::$instance, 'menu_item' ) );
+                    add_action( 'admin_init', array( self::$instance, 'register_settings' ) );
+                    add_action( 'admin_notices', array( self::$instance, 'admin_notices' ) );
+                }
+
+                do_action( 'wp_font_awesome_settings_loaded' );
+            }
+
+            return self::$instance;
+        }
+
+        /**
+         * Initiate the settings and add the required action hooks.
+         *
+         * @since 1.0.8 Settings name wrong - FIXED
+         */
+        public function init() {
+            // Download fontawesome locally.
+            add_action( 'add_option_wp-font-awesome-settings', array( $this, 'add_option_wp_font_awesome_settings' ), 10, 2 );
+            add_action( 'update_option_wp-font-awesome-settings', array( $this, 'update_option_wp_font_awesome_settings' ), 10, 2 );
+
+            $this->settings = $this->get_settings();
+
+            // check if the official plugin is active and use that instead if so.
+            if ( ! defined( 'FONTAWESOME_PLUGIN_FILE' ) ) {
+
+                if ( $this->settings['type'] == 'CSS' ) {
+
+                    if ( $this->settings['enqueue'] == '' || $this->settings['enqueue'] == 'frontend' ) {
+                        add_action( 'wp_enqueue_scripts', array( $this, 'enqueue_style' ), 5000 );
+                    }
+
+                    if ( $this->settings['enqueue'] == '' || $this->settings['enqueue'] == 'backend' ) {
+                        add_action( 'admin_enqueue_scripts', array( $this, 'enqueue_style' ), 5000 );
+                        add_filter( 'block_editor_settings_all', array( $this, 'enqueue_editor_styles' ), 10, 2 );
+                    }
+
+                } else {
+
+                    if ( $this->settings['enqueue'] == '' || $this->settings['enqueue'] == 'frontend' ) {
+                        add_action( 'wp_enqueue_scripts', array( $this, 'enqueue_scripts' ), 5000 );
+                    }
+
+                    if ( $this->settings['enqueue'] == '' || $this->settings['enqueue'] == 'backend' ) {
+                        add_action( 'admin_enqueue_scripts', array( $this, 'enqueue_scripts' ), 5000 );
+                        add_filter( 'block_editor_settings_all', array( $this, 'enqueue_editor_scripts' ), 10, 2 );
+                    }
+                }
+
+                // remove font awesome if set to do so
+                if ( $this->settings['dequeue'] == '1' ) {
+                    add_action( 'clean_url', array( $this, 'remove_font_awesome' ), 5000, 3 );
+                }
+            }
+
+        }
+
+        /**
+         * Add FA to the FSE.
+         *
+         * @param $editor_settings
+         * @param $block_editor_context
+         *
+         * @return array
+         */
+        public function enqueue_editor_styles( $editor_settings, $block_editor_context ){
+
+            if ( ! empty( $editor_settings['__unstableResolvedAssets']['styles'] ) ) {
+                $url = $this->get_url();
+                $editor_settings['__unstableResolvedAssets']['styles'] .= "<link rel='stylesheet' id='font-awesome-css'  href='$url' media='all' />";
+            }
+
+            return $editor_settings;
+        }
+
+        /**
+         * Add FA to the FSE.
+         *
+         * @param $editor_settings
+         * @param $block_editor_context
+         *
+         * @return array
+         */
+        public function enqueue_editor_scripts( $editor_settings, $block_editor_context ){
+
+            $url = $this->get_url();
+            $editor_settings['__unstableResolvedAssets']['scripts'] .= "<script src='$url' id='font-awesome-js'></script>";
+
+            return $editor_settings;
+        }
+
+        /**
+         * Adds the Font Awesome styles.
+         */
+        public function enqueue_style() {
+            // build url
+            $url = $this->get_url();
+            $version = ! empty( $this->settings['local'] ) && empty( $this->settings['pro'] ) ? strip_tags( $this->settings['local_version'] ) : null;
+
+            wp_deregister_style( 'font-awesome' ); // deregister in case its already there
+            wp_register_style( 'font-awesome', $url, array(), $version );
+            wp_enqueue_style( 'font-awesome' );
+
+            // RTL language support CSS.
+            if ( is_rtl() ) {
+                wp_add_inline_style( 'font-awesome', $this->rtl_inline_css() );
+            }
+
+            if ( $this->settings['shims'] ) {
+                $url = $this->get_url( true );
+                wp_deregister_style( 'font-awesome-shims' ); // deregister in case its already there
+                wp_register_style( 'font-awesome-shims', $url, array(), $version );
+                wp_enqueue_style( 'font-awesome-shims' );
+            }
+        }
+
+        /**
+         * Adds the Font Awesome JS.
+         */
+        public function enqueue_scripts() {
+            // build url
+            $url = $this->get_url();
+
+            $deregister_function = 'wp' . '_' . 'deregister' . '_' . 'script';
+            call_user_func( $deregister_function, 'font-awesome' ); // deregister in case its already there
+            wp_register_script( 'font-awesome', $url, array(), null );
+            wp_enqueue_script( 'font-awesome' );
+
+            if ( $this->settings['shims'] ) {
+                $url = $this->get_url( true );
+                call_user_func( $deregister_function, 'font-awesome-shims' ); // deregister in case its already there
+                wp_register_script( 'font-awesome-shims', $url, array(), null );
+                wp_enqueue_script( 'font-awesome-shims' );
+            }
+        }
+
+        /**
+         * Get the url of the Font Awesome files.
+         *
+         * @param bool $shims If this is a shim file or not.
+         * @param bool $local Load locally if allowed.
+         *
+         * @return string The url to the file.
+         */
+        public function get_url( $shims = false, $local = true ) {
+            $script  = $shims ? 'v4-shims' : 'all';
+            $sub     = $this->settings['pro'] ? 'pro' : 'use';
+            $type    = $this->settings['type'];
+            $version = $this->settings['version'];
+            $kit_url = $this->settings['kit-url'] ? esc_url( $this->settings['kit-url'] ) : '';
+            $url     = '';
+
+            if ( $type == 'KIT' && $kit_url ) {
+                if ( $shims ) {
+                    // if its a kit then we don't add shims here
+                    return '';
+                }
+                $url .= $kit_url; // CDN
+                $url .= "?wpfas=true"; // set our var so our version is not removed
+            } else {
+                $v = '';
+                // Check and load locally.
+                if ( $local && $this->has_local() ) {
+                    $script .= ".min";
+                    $v .= '&ver=' . strip_tags( $this->settings['local_version'] );
+                    $url .= $this->get_fonts_url(); // Local fonts url.
+                } else {
+                    $url .= "https://$sub.fontawesome.com/releases/"; // CDN
+                    $url .= ! empty( $version ) ? "v" . $version . '/' : "v" . $this->get_latest_version() . '/'; // version
+                }
+                $url .= $type == 'CSS' ? 'css/' : 'js/'; // type
+                $url .= $type == 'CSS' ? $script . '.css' : $script . '.js'; // type
+                $url .= "?wpfas=true" . $v; // set our var so our version is not removed
+            }
+
+            return $url;
+        }
+
+        /**
+         * Try and remove any other versions of Font Awesome added by other plugins/themes.
+         *
+         * Uses the clean_url filter to try and remove any other Font Awesome files added, it can also add pseudo-elements flag for the JS version.
+         *
+         * @param $url
+         * @param $original_url
+         * @param $_context
+         *
+         * @return string The filtered url.
+         */
+        public function remove_font_awesome( $url, $original_url, $_context ) {
+
+            if ( $_context == 'display'
+                 && ( strstr( $url, "fontawesome" ) !== false || strstr( $url, "font-awesome" ) !== false )
+                 && ( strstr( $url, ".js" ) !== false || strstr( $url, ".css" ) !== false )
+            ) {// it's a font-awesome-url (probably)
+
+                if ( strstr( $url, "wpfas=true" ) !== false ) {
+                    if ( $this->settings['type'] == 'JS' ) {
+                        if ( $this->settings['js-pseudo'] ) {
+                            $url .= "' data-search-pseudo-elements defer='defer";
+                        } else {
+                            $url .= "' defer='defer";
+                        }
+                    }
+                } else {
+                    $url = ''; // removing the url removes the file
+                }
+
+            }
+
+            return $url;
+        }
+
+        /**
+         * Register the database settings with WordPress.
+         */
+        public function register_settings() {
+            register_setting( 'wp-font-awesome-settings', 'wp-font-awesome-settings' );
+        }
+
+        /**
+         * Add the WordPress settings menu item.
+         * @since 1.0.10 Calling function name direct will fail theme check so we don't.
+         */
+        public function menu_item() {
+            $menu_function = 'add' . '_' . 'options' . '_' . 'page'; // won't pass theme check if function name present in theme
+            call_user_func( $menu_function, $this->name, $this->name, 'manage_options', 'wp-font-awesome-settings', array(
+                $this,
+                'settings_page'
+            ) );
+        }
+
+        /**
+         * Get the current Font Awesome output settings.
+         *
+         * @return array The array of settings.
+         */
+        public function get_settings() {
+            $db_settings = get_option( 'wp-font-awesome-settings' );
+
+            $defaults = array(
+                'type'      => 'CSS', // type to use, CSS or JS or KIT
+                'version'   => '', // latest
+                'enqueue'   => '', // front and backend
+                'shims'     => '0', // default OFF now in 2020
+                'js-pseudo' => '0', // if the pseudo elements flag should be set (CPU intensive)
+                'dequeue'   => '0', // if we should try to remove other versions added by other plugins/themes
+                'pro'       => '0', // if pro CDN url should be used
+                'local'     => '0', // Store fonts locally.
+                'local_version' => '', // Local fonts version.
+                'kit-url'   => '', // the kit url
+            );
+
+            $settings = wp_parse_args( $db_settings, $defaults );
+
+            /**
+             * Filter the Font Awesome settings.
+             *
+             * @todo if we add this filer people might use it and then it defeates the purpose of this class :/
+             */
+            return $this->settings = apply_filters( 'wp-font-awesome-settings', $settings, $db_settings, $defaults );
+        }
+
+        /**
+         * The settings page html output.
+         */
+        public function settings_page() {
+            if ( ! current_user_can( 'manage_options' ) ) {
+                wp_die( __( 'You do not have sufficient permissions to access this page.', 'font-awesome-settings' ) );
+            }
+
+            // a hidden way to force the update of the version number via api instead of waiting the 48 hours
+            if ( isset( $_REQUEST['force-version-check'] ) ) {
+                $this->get_latest_version( $force_api = true );
+            }
+
+            if ( ! defined( 'FONTAWESOME_PLUGIN_FILE' ) ) {
+                ?>
                 <style>
                     .wpfas-kit-show {
                         display: none;
@@ -402,16 +402,16 @@ 
                     <h1><?php echo $this->name; ?></h1>
                     <form method="post" action="options.php" class="fas-settings-form">
 						<?php
-						settings_fields( 'wp-font-awesome-settings' );
-						do_settings_sections( 'wp-font-awesome-settings' );
-						$table_class = '';
-						if ( $this->settings['type'] ) {
-							$table_class .= 'wpfas-' . sanitize_html_class( strtolower( $this->settings['type'] ) ) . '-set';
-						}
-						if ( ! empty( $this->settings['pro'] ) ) {
-							$table_class .= ' wpfas-has-pro';
-						}
-						?>
+                        settings_fields( 'wp-font-awesome-settings' );
+                        do_settings_sections( 'wp-font-awesome-settings' );
+                        $table_class = '';
+                        if ( $this->settings['type'] ) {
+                            $table_class .= 'wpfas-' . sanitize_html_class( strtolower( $this->settings['type'] ) ) . '-set';
+                        }
+                        if ( ! empty( $this->settings['pro'] ) ) {
+                            $table_class .= ' wpfas-has-pro';
+                        }
+                        ?>
 						<?php if ( $this->settings['type'] != 'KIT' && ! empty( $this->settings['local'] ) && empty( $this->settings['pro'] ) ) { ?>
 							<?php if ( $this->has_local() ) { ?>
 							<div class="notice notice-info"><p><strong><?php _e( 'Font Awesome fonts are loading locally.', 'font-awesome-settings' ); ?></strong></p></div>
@@ -436,12 +436,12 @@ 
                                 <td>
                                     <input class="regular-text" id="wpfas-kit-url" type="url" name="wp-font-awesome-settings[kit-url]" value="<?php echo esc_attr( $this->settings['kit-url'] ); ?>" placeholder="<?php echo 'https://kit.font';echo 'awesome.com/123abc.js'; // this won't pass theme check :(?>"/>
                                     <span><?php
-										echo sprintf(
-											__( 'Requires a free account with Font Awesome. %sGet kit url%s', 'font-awesome-settings' ),
-											'<a rel="noopener noreferrer" target="_blank" href="https://fontawesome.com/kits"><i class="fas fa-external-link-alt"></i>',
-											'</a>'
-										);
-										?></span>
+                                        echo sprintf(
+                                            __( 'Requires a free account with Font Awesome. %sGet kit url%s', 'font-awesome-settings' ),
+                                            '<a rel="noopener noreferrer" target="_blank" href="https://fontawesome.com/kits"><i class="fas fa-external-link-alt"></i>',
+                                            '</a>'
+                                        );
+                                        ?></span>
                                 </td>
                             </tr>
 
@@ -482,14 +482,14 @@ 
                                     <input type="hidden" name="wp-font-awesome-settings[pro]" value="0"/>
                                     <input type="checkbox" name="wp-font-awesome-settings[pro]" value="1" <?php checked( $this->settings['pro'], '1' ); ?> id="wpfas-pro" onchange="if(jQuery(this).is(':checked')){jQuery('.wpfas-table-settings').addClass('wpfas-has-pro')}else{jQuery('.wpfas-table-settings').removeClass('wpfas-has-pro')}"/>
                                     <span><?php
-										echo wp_sprintf(
-											__( 'Requires a subscription. %sLearn more%s  %sManage my allowed domains%s', 'font-awesome-settings' ),
-											'<a rel="noopener noreferrer" target="_blank" href="https://fontawesome.com/referral?a=c9b89e1418">',
-											' <i class="fas fa-external-link-alt"></i></a>',
-											'<a rel="noopener noreferrer" target="_blank" href="https://fontawesome.com/account/cdn">',
-											' <i class="fas fa-external-link-alt"></i></a>'
-										);
-										?></span>
+                                        echo wp_sprintf(
+                                            __( 'Requires a subscription. %sLearn more%s  %sManage my allowed domains%s', 'font-awesome-settings' ),
+                                            '<a rel="noopener noreferrer" target="_blank" href="https://fontawesome.com/referral?a=c9b89e1418">',
+                                            ' <i class="fas fa-external-link-alt"></i></a>',
+                                            '<a rel="noopener noreferrer" target="_blank" href="https://fontawesome.com/account/cdn">',
+                                            ' <i class="fas fa-external-link-alt"></i></a>'
+                                        );
+                                        ?></span>
                                 </td>
                             </tr>
 
@@ -543,8 +543,8 @@ 
                         </table>
                         <div class="fas-buttons">
 							<?php
-							submit_button();
-							?>
+                            submit_button();
+                            ?>
                             <p class="submit"><a href="https://fontawesome.com/referral?a=c9b89e1418" class="button button-secondary"><?php _e('Get 14,000+ more icons with Font Awesome Pro','font-awesome-settings'); ?> <i class="fas fa-external-link-alt"></i></a></p>
 
                         </div>
@@ -553,392 +553,392 @@ 
                     <div id="wpfas-version"><?php echo sprintf(__( 'Version: %s (affiliate links provided)', 'font-awesome-settings' ), $this->version ); ?></div>
                 </div>
 				<?php
-			}
-		}
-
-		/**
-		 * Check a version number is valid and if so return it or else return an empty string.
-		 *
-		 * @param $version string The version number to check.
-		 *
-		 * @since 1.0.6
-		 *
-		 * @return string Either a valid version number or an empty string.
-		 */
-		public function validate_version_number( $version ) {
-
-			if ( version_compare( $version, '0.0.1', '>=' ) >= 0 ) {
-				// valid
-			} else {
-				$version = '';// not validated
-			}
-
-			return $version;
-		}
-
-
-		/**
-		 * Get the latest version of Font Awesome.
-		 *
-		 * We check for a cached version and if none we will check for a live version via API and then cache it for 48 hours.
-		 *
-		 * @since 1.0.7
-		 * @return mixed|string The latest version number found.
-		 */
-		public function get_latest_version( $force_api = false ) {
-			$latest_version = $this->latest;
-
-			$cache = get_transient( 'wp-font-awesome-settings-version' );
-
-			if ( $cache === false || $force_api ) { // its not set
-				$api_ver = $this->get_latest_version_from_api();
-				if ( version_compare( $api_ver, $this->latest, '>=' ) >= 0 ) {
-					$latest_version = $api_ver;
-					set_transient( 'wp-font-awesome-settings-version', $api_ver, 48 * HOUR_IN_SECONDS );
-				}
-			} elseif ( $this->validate_version_number( $cache ) ) {
-				if ( version_compare( $cache, $this->latest, '>=' ) >= 0 ) {
-					$latest_version = $cache;
-				}
-			}
-
-			// Check and auto download fonts locally.
-			if ( empty( $this->settings['pro'] ) && empty( $this->settings['version'] ) && $this->settings['type'] != 'KIT' && ! empty( $this->settings['local'] ) && ! empty( $this->settings['local_version'] ) && ! empty( $latest_version ) ) {
-				if ( version_compare( $latest_version, $this->settings['local_version'], '>' ) && is_admin() && ! wp_doing_ajax() ) {
-					$this->download_package( $latest_version );
-				}
-			}
-
-			return $latest_version;
-		}
-
-		/**
-		 * Get the latest Font Awesome version from the github API.
-		 *
-		 * @since 1.0.7
-		 * @return string The latest version number or `0` on API fail.
-		 */
-		public function get_latest_version_from_api() {
-			$version  = "0";
-			$response = wp_remote_get( "https://api.github.com/repos/FortAwesome/Font-Awesome/releases/latest" );
-			if ( ! is_wp_error( $response ) && is_array( $response ) ) {
-				$api_response = json_decode( wp_remote_retrieve_body( $response ), true );
-				if ( isset( $api_response['tag_name'] ) && version_compare( $api_response['tag_name'], $this->latest, '>=' ) >= 0 && empty( $api_response['prerelease'] ) ) {
-					$version = $api_response['tag_name'];
-				}
-			}
-
-			return $version;
-		}
-
-		/**
-		 * Inline CSS for RTL language support.
-		 *
-		 * @since 1.0.13
-		 * @return string Inline CSS.
-		 */
-		public function rtl_inline_css() {
-			$inline_css = '[dir=rtl] .fa-address,[dir=rtl] .fa-address-card,[dir=rtl] .fa-adjust,[dir=rtl] .fa-alarm-clock,[dir=rtl] .fa-align-left,[dir=rtl] .fa-align-right,[dir=rtl] .fa-analytics,[dir=rtl] .fa-angle-double-left,[dir=rtl] .fa-angle-double-right,[dir=rtl] .fa-angle-left,[dir=rtl] .fa-angle-right,[dir=rtl] .fa-arrow-alt-circle-left,[dir=rtl] .fa-arrow-alt-circle-right,[dir=rtl] .fa-arrow-alt-from-left,[dir=rtl] .fa-arrow-alt-from-right,[dir=rtl] .fa-arrow-alt-left,[dir=rtl] .fa-arrow-alt-right,[dir=rtl] .fa-arrow-alt-square-left,[dir=rtl] .fa-arrow-alt-square-right,[dir=rtl] .fa-arrow-alt-to-left,[dir=rtl] .fa-arrow-alt-to-right,[dir=rtl] .fa-arrow-circle-left,[dir=rtl] .fa-arrow-circle-right,[dir=rtl] .fa-arrow-from-left,[dir=rtl] .fa-arrow-from-right,[dir=rtl] .fa-arrow-left,[dir=rtl] .fa-arrow-right,[dir=rtl] .fa-arrow-square-left,[dir=rtl] .fa-arrow-square-right,[dir=rtl] .fa-arrow-to-left,[dir=rtl] .fa-arrow-to-right,[dir=rtl] .fa-balance-scale-left,[dir=rtl] .fa-balance-scale-right,[dir=rtl] .fa-bed,[dir=rtl] .fa-bed-bunk,[dir=rtl] .fa-bed-empty,[dir=rtl] .fa-border-left,[dir=rtl] .fa-border-right,[dir=rtl] .fa-calendar-check,[dir=rtl] .fa-caret-circle-left,[dir=rtl] .fa-caret-circle-right,[dir=rtl] .fa-caret-left,[dir=rtl] .fa-caret-right,[dir=rtl] .fa-caret-square-left,[dir=rtl] .fa-caret-square-right,[dir=rtl] .fa-cart-arrow-down,[dir=rtl] .fa-cart-plus,[dir=rtl] .fa-chart-area,[dir=rtl] .fa-chart-bar,[dir=rtl] .fa-chart-line,[dir=rtl] .fa-chart-line-down,[dir=rtl] .fa-chart-network,[dir=rtl] .fa-chart-pie,[dir=rtl] .fa-chart-pie-alt,[dir=rtl] .fa-chart-scatter,[dir=rtl] .fa-check-circle,[dir=rtl] .fa-check-square,[dir=rtl] .fa-chevron-circle-left,[dir=rtl] .fa-chevron-circle-right,[dir=rtl] .fa-chevron-double-left,[dir=rtl] .fa-chevron-double-right,[dir=rtl] .fa-chevron-left,[dir=rtl] .fa-chevron-right,[dir=rtl] .fa-chevron-square-left,[dir=rtl] .fa-chevron-square-right,[dir=rtl] .fa-clock,[dir=rtl] .fa-file,[dir=rtl] .fa-file-alt,[dir=rtl] .fa-file-archive,[dir=rtl] .fa-file-audio,[dir=rtl] .fa-file-chart-line,[dir=rtl] .fa-file-chart-pie,[dir=rtl] .fa-file-code,[dir=rtl] .fa-file-excel,[dir=rtl] .fa-file-image,[dir=rtl] .fa-file-pdf,[dir=rtl] .fa-file-powerpoint,[dir=rtl] .fa-file-video,[dir=rtl] .fa-file-word,[dir=rtl] .fa-flag,[dir=rtl] .fa-folder,[dir=rtl] .fa-folder-open,[dir=rtl] .fa-hand-lizard,[dir=rtl] .fa-hand-point-down,[dir=rtl] .fa-hand-point-left,[dir=rtl] .fa-hand-point-right,[dir=rtl] .fa-hand-point-up,[dir=rtl] .fa-hand-scissors,[dir=rtl] .fa-image,[dir=rtl] .fa-long-arrow-alt-left,[dir=rtl] .fa-long-arrow-alt-right,[dir=rtl] .fa-long-arrow-left,[dir=rtl] .fa-long-arrow-right,[dir=rtl] .fa-luggage-cart,[dir=rtl] .fa-moon,[dir=rtl] .fa-pencil,[dir=rtl] .fa-pencil-alt,[dir=rtl] .fa-play-circle,[dir=rtl] .fa-project-diagram,[dir=rtl] .fa-quote-left,[dir=rtl] .fa-quote-right,[dir=rtl] .fa-shopping-cart,[dir=rtl] .fa-thumbs-down,[dir=rtl] .fa-thumbs-up,[dir=rtl] .fa-user-chart{filter: progid:DXImageTransform.Microsoft.BasicImage(rotation=0, mirror=1);transform:scale(-1,1)}[dir=rtl] .fa-spin{animation-direction:reverse}';
-
-			return $inline_css;
-		}
-
-		/**
-		 * Show any warnings as an admin notice.
-		 *
-		 * @return void
-		 */
-		public function admin_notices() {
-			$settings = $this->settings;
-
-			if ( defined( 'FONTAWESOME_PLUGIN_FILE' ) ) {
-				if ( ! empty( $_REQUEST['page'] ) && $_REQUEST['page'] == 'wp-font-awesome-settings' ) {
-					?>
+            }
+        }
+
+        /**
+         * Check a version number is valid and if so return it or else return an empty string.
+         *
+         * @param $version string The version number to check.
+         *
+         * @since 1.0.6
+         *
+         * @return string Either a valid version number or an empty string.
+         */
+        public function validate_version_number( $version ) {
+
+            if ( version_compare( $version, '0.0.1', '>=' ) >= 0 ) {
+                // valid
+            } else {
+                $version = '';// not validated
+            }
+
+            return $version;
+        }
+
+
+        /**
+         * Get the latest version of Font Awesome.
+         *
+         * We check for a cached version and if none we will check for a live version via API and then cache it for 48 hours.
+         *
+         * @since 1.0.7
+         * @return mixed|string The latest version number found.
+         */
+        public function get_latest_version( $force_api = false ) {
+            $latest_version = $this->latest;
+
+            $cache = get_transient( 'wp-font-awesome-settings-version' );
+
+            if ( $cache === false || $force_api ) { // its not set
+                $api_ver = $this->get_latest_version_from_api();
+                if ( version_compare( $api_ver, $this->latest, '>=' ) >= 0 ) {
+                    $latest_version = $api_ver;
+                    set_transient( 'wp-font-awesome-settings-version', $api_ver, 48 * HOUR_IN_SECONDS );
+                }
+            } elseif ( $this->validate_version_number( $cache ) ) {
+                if ( version_compare( $cache, $this->latest, '>=' ) >= 0 ) {
+                    $latest_version = $cache;
+                }
+            }
+
+            // Check and auto download fonts locally.
+            if ( empty( $this->settings['pro'] ) && empty( $this->settings['version'] ) && $this->settings['type'] != 'KIT' && ! empty( $this->settings['local'] ) && ! empty( $this->settings['local_version'] ) && ! empty( $latest_version ) ) {
+                if ( version_compare( $latest_version, $this->settings['local_version'], '>' ) && is_admin() && ! wp_doing_ajax() ) {
+                    $this->download_package( $latest_version );
+                }
+            }
+
+            return $latest_version;
+        }
+
+        /**
+         * Get the latest Font Awesome version from the github API.
+         *
+         * @since 1.0.7
+         * @return string The latest version number or `0` on API fail.
+         */
+        public function get_latest_version_from_api() {
+            $version  = "0";
+            $response = wp_remote_get( "https://api.github.com/repos/FortAwesome/Font-Awesome/releases/latest" );
+            if ( ! is_wp_error( $response ) && is_array( $response ) ) {
+                $api_response = json_decode( wp_remote_retrieve_body( $response ), true );
+                if ( isset( $api_response['tag_name'] ) && version_compare( $api_response['tag_name'], $this->latest, '>=' ) >= 0 && empty( $api_response['prerelease'] ) ) {
+                    $version = $api_response['tag_name'];
+                }
+            }
+
+            return $version;
+        }
+
+        /**
+         * Inline CSS for RTL language support.
+         *
+         * @since 1.0.13
+         * @return string Inline CSS.
+         */
+        public function rtl_inline_css() {
+            $inline_css = '[dir=rtl] .fa-address,[dir=rtl] .fa-address-card,[dir=rtl] .fa-adjust,[dir=rtl] .fa-alarm-clock,[dir=rtl] .fa-align-left,[dir=rtl] .fa-align-right,[dir=rtl] .fa-analytics,[dir=rtl] .fa-angle-double-left,[dir=rtl] .fa-angle-double-right,[dir=rtl] .fa-angle-left,[dir=rtl] .fa-angle-right,[dir=rtl] .fa-arrow-alt-circle-left,[dir=rtl] .fa-arrow-alt-circle-right,[dir=rtl] .fa-arrow-alt-from-left,[dir=rtl] .fa-arrow-alt-from-right,[dir=rtl] .fa-arrow-alt-left,[dir=rtl] .fa-arrow-alt-right,[dir=rtl] .fa-arrow-alt-square-left,[dir=rtl] .fa-arrow-alt-square-right,[dir=rtl] .fa-arrow-alt-to-left,[dir=rtl] .fa-arrow-alt-to-right,[dir=rtl] .fa-arrow-circle-left,[dir=rtl] .fa-arrow-circle-right,[dir=rtl] .fa-arrow-from-left,[dir=rtl] .fa-arrow-from-right,[dir=rtl] .fa-arrow-left,[dir=rtl] .fa-arrow-right,[dir=rtl] .fa-arrow-square-left,[dir=rtl] .fa-arrow-square-right,[dir=rtl] .fa-arrow-to-left,[dir=rtl] .fa-arrow-to-right,[dir=rtl] .fa-balance-scale-left,[dir=rtl] .fa-balance-scale-right,[dir=rtl] .fa-bed,[dir=rtl] .fa-bed-bunk,[dir=rtl] .fa-bed-empty,[dir=rtl] .fa-border-left,[dir=rtl] .fa-border-right,[dir=rtl] .fa-calendar-check,[dir=rtl] .fa-caret-circle-left,[dir=rtl] .fa-caret-circle-right,[dir=rtl] .fa-caret-left,[dir=rtl] .fa-caret-right,[dir=rtl] .fa-caret-square-left,[dir=rtl] .fa-caret-square-right,[dir=rtl] .fa-cart-arrow-down,[dir=rtl] .fa-cart-plus,[dir=rtl] .fa-chart-area,[dir=rtl] .fa-chart-bar,[dir=rtl] .fa-chart-line,[dir=rtl] .fa-chart-line-down,[dir=rtl] .fa-chart-network,[dir=rtl] .fa-chart-pie,[dir=rtl] .fa-chart-pie-alt,[dir=rtl] .fa-chart-scatter,[dir=rtl] .fa-check-circle,[dir=rtl] .fa-check-square,[dir=rtl] .fa-chevron-circle-left,[dir=rtl] .fa-chevron-circle-right,[dir=rtl] .fa-chevron-double-left,[dir=rtl] .fa-chevron-double-right,[dir=rtl] .fa-chevron-left,[dir=rtl] .fa-chevron-right,[dir=rtl] .fa-chevron-square-left,[dir=rtl] .fa-chevron-square-right,[dir=rtl] .fa-clock,[dir=rtl] .fa-file,[dir=rtl] .fa-file-alt,[dir=rtl] .fa-file-archive,[dir=rtl] .fa-file-audio,[dir=rtl] .fa-file-chart-line,[dir=rtl] .fa-file-chart-pie,[dir=rtl] .fa-file-code,[dir=rtl] .fa-file-excel,[dir=rtl] .fa-file-image,[dir=rtl] .fa-file-pdf,[dir=rtl] .fa-file-powerpoint,[dir=rtl] .fa-file-video,[dir=rtl] .fa-file-word,[dir=rtl] .fa-flag,[dir=rtl] .fa-folder,[dir=rtl] .fa-folder-open,[dir=rtl] .fa-hand-lizard,[dir=rtl] .fa-hand-point-down,[dir=rtl] .fa-hand-point-left,[dir=rtl] .fa-hand-point-right,[dir=rtl] .fa-hand-point-up,[dir=rtl] .fa-hand-scissors,[dir=rtl] .fa-image,[dir=rtl] .fa-long-arrow-alt-left,[dir=rtl] .fa-long-arrow-alt-right,[dir=rtl] .fa-long-arrow-left,[dir=rtl] .fa-long-arrow-right,[dir=rtl] .fa-luggage-cart,[dir=rtl] .fa-moon,[dir=rtl] .fa-pencil,[dir=rtl] .fa-pencil-alt,[dir=rtl] .fa-play-circle,[dir=rtl] .fa-project-diagram,[dir=rtl] .fa-quote-left,[dir=rtl] .fa-quote-right,[dir=rtl] .fa-shopping-cart,[dir=rtl] .fa-thumbs-down,[dir=rtl] .fa-thumbs-up,[dir=rtl] .fa-user-chart{filter: progid:DXImageTransform.Microsoft.BasicImage(rotation=0, mirror=1);transform:scale(-1,1)}[dir=rtl] .fa-spin{animation-direction:reverse}';
+
+            return $inline_css;
+        }
+
+        /**
+         * Show any warnings as an admin notice.
+         *
+         * @return void
+         */
+        public function admin_notices() {
+            $settings = $this->settings;
+
+            if ( defined( 'FONTAWESOME_PLUGIN_FILE' ) ) {
+                if ( ! empty( $_REQUEST['page'] ) && $_REQUEST['page'] == 'wp-font-awesome-settings' ) {
+                    ?>
                     <div class="notice  notice-error is-dismissible">
                         <p><?php _e( 'The Official Font Awesome Plugin is active, please adjust your settings there.', 'font-awesome-settings' ); ?></p>
                     </div>
 					<?php
-				}
-			} else {
-				if ( ! empty( $settings ) ) {
-					if ( $settings['type'] != 'KIT' && $settings['pro'] && ( $settings['version'] == '' || version_compare( $settings['version'], '6', '>=' ) ) ) {
-						$link = admin_url('options-general.php?page=wp-font-awesome-settings');
-						?>
+                }
+            } else {
+                if ( ! empty( $settings ) ) {
+                    if ( $settings['type'] != 'KIT' && $settings['pro'] && ( $settings['version'] == '' || version_compare( $settings['version'], '6', '>=' ) ) ) {
+                        $link = admin_url('options-general.php?page=wp-font-awesome-settings');
+                        ?>
                         <div class="notice  notice-error is-dismissible">
                             <p><?php echo sprintf( __( 'Font Awesome Pro v6 requires the use of a kit, please setup your kit in %ssettings.%s', 'font-awesome-settings' ),"<a href='". esc_url_raw( $link )."'>","</a>" ); ?></p>
                         </div>
 						<?php
-					}
-				}
-			}
-		}
-
-		/**
-		 * Handle fontawesome add settings to download fontawesome to store locally.
-		 *
-		 * @since 1.1.1
-		 *
-		 * @param string $option The option name.
-		 * @param mixed  $value  The option value.
-		 */
-		public function add_option_wp_font_awesome_settings( $option, $value ) {
-			// Do nothing if WordPress is being installed.
-			if ( wp_installing() ) {
-				return;
-			}
-
-			if ( ! empty( $value['local'] ) && empty( $value['pro'] ) && ! ( ! empty( $value['type'] ) && $value['type'] == 'KIT' ) ) {
-				$version = isset( $value['version'] ) && $value['version'] ? $value['version'] : $this->get_latest_version();
-
-				if ( ! empty( $version ) ) {
-					$response = $this->download_package( $version, $value );
-
-					if ( is_wp_error( $response ) ) {
-						add_settings_error( 'general', 'fontawesome_download', __( 'ERROR:', 'font-awesome-settings' ) . ' ' . $response->get_error_message(), 'error' );
-					}
-				}
-			}
-		}
-
-		/**
-		 * Handle fontawesome update settings to download fontawesome to store locally.
-		 *
-		 * @since 1.1.0
-		 *
-		 * @param mixed $old_value The old option value.
-		 * @param mixed $value     The new option value.
-		 */
-		public function update_option_wp_font_awesome_settings( $old_value, $new_value ) {
-			// Do nothing if WordPress is being installed.
-			if ( wp_installing() ) {
-				return;
-			}
-
-			if ( ! empty( $new_value['local'] ) && empty( $new_value['pro'] ) && ! ( ! empty( $new_value['type'] ) && $new_value['type'] == 'KIT' ) ) {
-				// Old values
-				$old_version = isset( $old_value['version'] ) && $old_value['version'] ? $old_value['version'] : ( isset( $old_value['local_version'] ) ? $old_value['local_version'] : '' );
-				$old_local = isset( $old_value['local'] ) ? (int) $old_value['local'] : 0;
-
-				// New values
-				$new_version = isset( $new_value['version'] ) && $new_value['version'] ? $new_value['version'] : $this->get_latest_version();
-
-				if ( empty( $old_local ) || $old_version !== $new_version || ! file_exists( $this->get_fonts_dir() . 'css' . DIRECTORY_SEPARATOR . 'all.css' ) ) {
-					$response = $this->download_package( $new_version, $new_value );
-
-					if ( is_wp_error( $response ) ) {
-						add_settings_error( 'general', 'fontawesome_download', __( 'ERROR:', 'font-awesome-settings' ) . ' ' . $response->get_error_message(), 'error' );
-					}
-				}
-			}
-		}
-
-		/**
-		 * Get the fonts directory local path.
-		 *
-		 * @since 1.1.0
-		 *
-		 * @param string Fonts directory local path.
-		 */
-		public function get_fonts_dir() {
-			$upload_dir = wp_upload_dir( null, false );
-
-			return $upload_dir['basedir'] . DIRECTORY_SEPARATOR .  'ayefonts' . DIRECTORY_SEPARATOR . 'fa' . DIRECTORY_SEPARATOR;
-		}
-
-		/**
-		 * Get the fonts directory local url.
-		 *
-		 * @since 1.1.0
-		 *
-		 * @param string Fonts directory local url.
-		 */
-		public function get_fonts_url() {
-			$upload_dir = wp_upload_dir( null, false );
-
-			return $upload_dir['baseurl'] .  '/ayefonts/fa/';
-		}
-
-		/**
-		 * Check whether load locally active.
-		 *
-		 * @since 1.1.0
-		 *
-		 * @return bool True if active else false.
-		 */
-		public function has_local() {
-			if ( ! empty( $this->settings['local'] ) && empty( $this->settings['pro'] ) && file_exists( $this->get_fonts_dir() . 'css' . DIRECTORY_SEPARATOR . 'all.css' ) ) {
-				return true;
-			}
-
-			return false;
-		}
-
-		/**
-		 * Get the WP Filesystem access.
-		 *
-		 * @since 1.1.0
-		 *
-		 * @return object The WP Filesystem.
-		 */
-		public function get_wp_filesystem() {
-			if ( ! function_exists( 'get_filesystem_method' ) ) {
-				require_once( ABSPATH . "/wp-admin/includes/file.php" );
-			}
-
-			$access_type = get_filesystem_method();
-
-			if ( $access_type === 'direct' ) {
-				/* You can safely run request_filesystem_credentials() without any issues and don't need to worry about passing in a URL */
-				$creds = request_filesystem_credentials( trailingslashit( site_url() ) . 'wp-admin/', '', false, false, array() );
-
-				/* Initialize the API */
-				if ( ! WP_Filesystem( $creds ) ) {
-					/* Any problems and we exit */
-					return false;
-				}
-
-				global $wp_filesystem;
-
-				return $wp_filesystem;
-				/* Do our file manipulations below */
-			} else if ( defined( 'FTP_USER' ) ) {
-				$creds = request_filesystem_credentials( trailingslashit( site_url() ) . 'wp-admin/', '', false, false, array() );
-
-				/* Initialize the API */
-				if ( ! WP_Filesystem( $creds ) ) {
-					/* Any problems and we exit */
-					return false;
-				}
-
-				global $wp_filesystem;
-
-				return $wp_filesystem;
-			} else {
-				/* Don't have direct write access. Prompt user with our notice */
-				return false;
-			}
-		}
-
-		/**
-		 * Download the fontawesome package file.
-		 *
-		 * @since 1.1.0
-		 *
-		 * @param mixed $version The font awesome.
-		 * @param array $option Fontawesome settings.
-		 * @return WP_ERROR|bool Error on fail and true on success.
-		 */
-		public function download_package( $version, $option = array() ) {
-			$filename = 'fontawesome-free-' . $version . '-web';
-			$url = 'https://use.fontawesome.com/releases/v' . $version . '/' . $filename . '.zip';
-
-			if ( ! function_exists( 'wp_handle_upload' ) ) {
-				require_once ABSPATH . 'wp-admin/includes/file.php';
-			}
-
-			$download_file = download_url( esc_url_raw( $url ) );
-
-			if ( is_wp_error( $download_file ) ) {
-				return new WP_Error( 'fontawesome_download_failed', __( $download_file->get_error_message(), 'font-awesome-settings' ) );
-			} else if ( empty( $download_file ) ) {
-				return new WP_Error( 'fontawesome_download_failed', __( 'Something went wrong in downloading the font awesome to store locally.', 'font-awesome-settings' ) );
-			}
-
-			$response = $this->extract_package( $download_file, $filename, true );
-
-			// Update local version.
-			if ( is_wp_error( $response ) ) {
-				return $response;
-			} else if ( $response ) {
-				if ( empty( $option ) ) {
-					$option = get_option( 'wp-font-awesome-settings' );
-				}
-
-				$option['local_version'] = $version;
-
-				// Remove action to prevent looping.
-				remove_action( 'update_option_wp-font-awesome-settings', array( $this, 'update_option_wp_font_awesome_settings' ), 10, 2 );
-
-				update_option( 'wp-font-awesome-settings', $option );
-
-				return true;
-			}
-
-			return false;
-		}
-
-		/**
-		 * Extract the fontawesome package file.
-		 *
-		 * @since 1.1.0
-		 *
-		 * @param string $package The package file path.
-		 * @param string $dirname Package file name.
-		 * @param bool   $delete_package Delete temp file or not.
-		 * @return WP_Error|bool True on success WP_Error on fail.
-		 */
-		public function extract_package( $package, $dirname = '', $delete_package = false ) {
-			global $wp_filesystem;
-
-			$wp_filesystem = $this->get_wp_filesystem();
-
-			if ( empty( $wp_filesystem ) && isset( $wp_filesystem->errors ) && is_wp_error( $wp_filesystem->errors ) && $wp_filesystem->errors->get_error_code() ) {
-				return new WP_Error( 'fontawesome_filesystem_error', __( $wp_filesystem->errors->get_error_message(), 'font-awesome-settings' ) );
-			} else if ( empty( $wp_filesystem ) ) {
-				return new WP_Error( 'fontawesome_filesystem_error', __( 'Failed to initialise WP_Filesystem while trying to download the Font Awesome package.', 'font-awesome-settings' ) );
-			}
-
-			$fonts_dir = $this->get_fonts_dir();
-			$fonts_tmp_dir = dirname( $fonts_dir ) . DIRECTORY_SEPARATOR . 'fa-tmp' . DIRECTORY_SEPARATOR;
-
-			if ( $wp_filesystem->is_dir( $fonts_tmp_dir ) ) {
-				$wp_filesystem->delete( $fonts_tmp_dir, true );
-			}
-
-			// Unzip package to working directory.
-			$result = unzip_file( $package, $fonts_tmp_dir );
-
-			if ( is_wp_error( $result ) ) {
-				$wp_filesystem->delete( $fonts_tmp_dir, true );
-
-				if ( 'incompatible_archive' === $result->get_error_code() ) {
-					return new WP_Error( 'fontawesome_incompatible_archive', __( $result->get_error_message(), 'font-awesome-settings' ) );
-				}
-
-				return $result;
-			}
-
-			if ( $wp_filesystem->is_dir( $fonts_dir ) ) {
-				$wp_filesystem->delete( $fonts_dir, true );
-			}
-
-			$extract_dir = $fonts_tmp_dir;
-
-			if ( $dirname && $wp_filesystem->is_dir( $extract_dir . $dirname . DIRECTORY_SEPARATOR ) ) {
-				$extract_dir .= $dirname . DIRECTORY_SEPARATOR;
-			}
-
-			try {
-				$return = $wp_filesystem->move( $extract_dir, $fonts_dir, true );
-			} catch ( Exception $e ) {
-				$return = new WP_Error( 'fontawesome_move_package', __( 'Fail to move font awesome package!', 'font-awesome-settings' ) );
-			}
-
-			if ( $wp_filesystem->is_dir( $fonts_tmp_dir ) ) {
-				$wp_filesystem->delete( $fonts_tmp_dir, true );
-			}
-
-			// Once extracted, delete the package if required.
-			if ( $delete_package ) {
-				unlink( $package );
-			}
-
-			return $return;
-		}
-	}
-
-	/**
-	 * Run the class if found.
-	 */
-	WP_Font_Awesome_Settings::instance();
+                    }
+                }
+            }
+        }
+
+        /**
+         * Handle fontawesome add settings to download fontawesome to store locally.
+         *
+         * @since 1.1.1
+         *
+         * @param string $option The option name.
+         * @param mixed  $value  The option value.
+         */
+        public function add_option_wp_font_awesome_settings( $option, $value ) {
+            // Do nothing if WordPress is being installed.
+            if ( wp_installing() ) {
+                return;
+            }
+
+            if ( ! empty( $value['local'] ) && empty( $value['pro'] ) && ! ( ! empty( $value['type'] ) && $value['type'] == 'KIT' ) ) {
+                $version = isset( $value['version'] ) && $value['version'] ? $value['version'] : $this->get_latest_version();
+
+                if ( ! empty( $version ) ) {
+                    $response = $this->download_package( $version, $value );
+
+                    if ( is_wp_error( $response ) ) {
+                        add_settings_error( 'general', 'fontawesome_download', __( 'ERROR:', 'font-awesome-settings' ) . ' ' . $response->get_error_message(), 'error' );
+                    }
+                }
+            }
+        }
+
+        /**
+         * Handle fontawesome update settings to download fontawesome to store locally.
+         *
+         * @since 1.1.0
+         *
+         * @param mixed $old_value The old option value.
+         * @param mixed $value     The new option value.
+         */
+        public function update_option_wp_font_awesome_settings( $old_value, $new_value ) {
+            // Do nothing if WordPress is being installed.
+            if ( wp_installing() ) {
+                return;
+            }
+
+            if ( ! empty( $new_value['local'] ) && empty( $new_value['pro'] ) && ! ( ! empty( $new_value['type'] ) && $new_value['type'] == 'KIT' ) ) {
+                // Old values
+                $old_version = isset( $old_value['version'] ) && $old_value['version'] ? $old_value['version'] : ( isset( $old_value['local_version'] ) ? $old_value['local_version'] : '' );
+                $old_local = isset( $old_value['local'] ) ? (int) $old_value['local'] : 0;
+
+                // New values
+                $new_version = isset( $new_value['version'] ) && $new_value['version'] ? $new_value['version'] : $this->get_latest_version();
+
+                if ( empty( $old_local ) || $old_version !== $new_version || ! file_exists( $this->get_fonts_dir() . 'css' . DIRECTORY_SEPARATOR . 'all.css' ) ) {
+                    $response = $this->download_package( $new_version, $new_value );
+
+                    if ( is_wp_error( $response ) ) {
+                        add_settings_error( 'general', 'fontawesome_download', __( 'ERROR:', 'font-awesome-settings' ) . ' ' . $response->get_error_message(), 'error' );
+                    }
+                }
+            }
+        }
+
+        /**
+         * Get the fonts directory local path.
+         *
+         * @since 1.1.0
+         *
+         * @param string Fonts directory local path.
+         */
+        public function get_fonts_dir() {
+            $upload_dir = wp_upload_dir( null, false );
+
+            return $upload_dir['basedir'] . DIRECTORY_SEPARATOR .  'ayefonts' . DIRECTORY_SEPARATOR . 'fa' . DIRECTORY_SEPARATOR;
+        }
+
+        /**
+         * Get the fonts directory local url.
+         *
+         * @since 1.1.0
+         *
+         * @param string Fonts directory local url.
+         */
+        public function get_fonts_url() {
+            $upload_dir = wp_upload_dir( null, false );
+
+            return $upload_dir['baseurl'] .  '/ayefonts/fa/';
+        }
+
+        /**
+         * Check whether load locally active.
+         *
+         * @since 1.1.0
+         *
+         * @return bool True if active else false.
+         */
+        public function has_local() {
+            if ( ! empty( $this->settings['local'] ) && empty( $this->settings['pro'] ) && file_exists( $this->get_fonts_dir() . 'css' . DIRECTORY_SEPARATOR . 'all.css' ) ) {
+                return true;
+            }
+
+            return false;
+        }
+
+        /**
+         * Get the WP Filesystem access.
+         *
+         * @since 1.1.0
+         *
+         * @return object The WP Filesystem.
+         */
+        public function get_wp_filesystem() {
+            if ( ! function_exists( 'get_filesystem_method' ) ) {
+                require_once( ABSPATH . "/wp-admin/includes/file.php" );
+            }
+
+            $access_type = get_filesystem_method();
+
+            if ( $access_type === 'direct' ) {
+                /* You can safely run request_filesystem_credentials() without any issues and don't need to worry about passing in a URL */
+                $creds = request_filesystem_credentials( trailingslashit( site_url() ) . 'wp-admin/', '', false, false, array() );
+
+                /* Initialize the API */
+                if ( ! WP_Filesystem( $creds ) ) {
+                    /* Any problems and we exit */
+                    return false;
+                }
+
+                global $wp_filesystem;
+
+                return $wp_filesystem;
+                /* Do our file manipulations below */
+            } else if ( defined( 'FTP_USER' ) ) {
+                $creds = request_filesystem_credentials( trailingslashit( site_url() ) . 'wp-admin/', '', false, false, array() );
+
+                /* Initialize the API */
+                if ( ! WP_Filesystem( $creds ) ) {
+                    /* Any problems and we exit */
+                    return false;
+                }
+
+                global $wp_filesystem;
+
+                return $wp_filesystem;
+            } else {
+                /* Don't have direct write access. Prompt user with our notice */
+                return false;
+            }
+        }
+
+        /**
+         * Download the fontawesome package file.
+         *
+         * @since 1.1.0
+         *
+         * @param mixed $version The font awesome.
+         * @param array $option Fontawesome settings.
+         * @return WP_ERROR|bool Error on fail and true on success.
+         */
+        public function download_package( $version, $option = array() ) {
+            $filename = 'fontawesome-free-' . $version . '-web';
+            $url = 'https://use.fontawesome.com/releases/v' . $version . '/' . $filename . '.zip';
+
+            if ( ! function_exists( 'wp_handle_upload' ) ) {
+                require_once ABSPATH . 'wp-admin/includes/file.php';
+            }
+
+            $download_file = download_url( esc_url_raw( $url ) );
+
+            if ( is_wp_error( $download_file ) ) {
+                return new WP_Error( 'fontawesome_download_failed', __( $download_file->get_error_message(), 'font-awesome-settings' ) );
+            } else if ( empty( $download_file ) ) {
+                return new WP_Error( 'fontawesome_download_failed', __( 'Something went wrong in downloading the font awesome to store locally.', 'font-awesome-settings' ) );
+            }
+
+            $response = $this->extract_package( $download_file, $filename, true );
+
+            // Update local version.
+            if ( is_wp_error( $response ) ) {
+                return $response;
+            } else if ( $response ) {
+                if ( empty( $option ) ) {
+                    $option = get_option( 'wp-font-awesome-settings' );
+                }
+
+                $option['local_version'] = $version;
+
+                // Remove action to prevent looping.
+                remove_action( 'update_option_wp-font-awesome-settings', array( $this, 'update_option_wp_font_awesome_settings' ), 10, 2 );
+
+                update_option( 'wp-font-awesome-settings', $option );
+
+                return true;
+            }
+
+            return false;
+        }
+
+        /**
+         * Extract the fontawesome package file.
+         *
+         * @since 1.1.0
+         *
+         * @param string $package The package file path.
+         * @param string $dirname Package file name.
+         * @param bool   $delete_package Delete temp file or not.
+         * @return WP_Error|bool True on success WP_Error on fail.
+         */
+        public function extract_package( $package, $dirname = '', $delete_package = false ) {
+            global $wp_filesystem;
+
+            $wp_filesystem = $this->get_wp_filesystem();
+
+            if ( empty( $wp_filesystem ) && isset( $wp_filesystem->errors ) && is_wp_error( $wp_filesystem->errors ) && $wp_filesystem->errors->get_error_code() ) {
+                return new WP_Error( 'fontawesome_filesystem_error', __( $wp_filesystem->errors->get_error_message(), 'font-awesome-settings' ) );
+            } else if ( empty( $wp_filesystem ) ) {
+                return new WP_Error( 'fontawesome_filesystem_error', __( 'Failed to initialise WP_Filesystem while trying to download the Font Awesome package.', 'font-awesome-settings' ) );
+            }
+
+            $fonts_dir = $this->get_fonts_dir();
+            $fonts_tmp_dir = dirname( $fonts_dir ) . DIRECTORY_SEPARATOR . 'fa-tmp' . DIRECTORY_SEPARATOR;
+
+            if ( $wp_filesystem->is_dir( $fonts_tmp_dir ) ) {
+                $wp_filesystem->delete( $fonts_tmp_dir, true );
+            }
+
+            // Unzip package to working directory.
+            $result = unzip_file( $package, $fonts_tmp_dir );
+
+            if ( is_wp_error( $result ) ) {
+                $wp_filesystem->delete( $fonts_tmp_dir, true );
+
+                if ( 'incompatible_archive' === $result->get_error_code() ) {
+                    return new WP_Error( 'fontawesome_incompatible_archive', __( $result->get_error_message(), 'font-awesome-settings' ) );
+                }
+
+                return $result;
+            }
+
+            if ( $wp_filesystem->is_dir( $fonts_dir ) ) {
+                $wp_filesystem->delete( $fonts_dir, true );
+            }
+
+            $extract_dir = $fonts_tmp_dir;
+
+            if ( $dirname && $wp_filesystem->is_dir( $extract_dir . $dirname . DIRECTORY_SEPARATOR ) ) {
+                $extract_dir .= $dirname . DIRECTORY_SEPARATOR;
+            }
+
+            try {
+                $return = $wp_filesystem->move( $extract_dir, $fonts_dir, true );
+            } catch ( Exception $e ) {
+                $return = new WP_Error( 'fontawesome_move_package', __( 'Fail to move font awesome package!', 'font-awesome-settings' ) );
+            }
+
+            if ( $wp_filesystem->is_dir( $fonts_tmp_dir ) ) {
+                $wp_filesystem->delete( $fonts_tmp_dir, true );
+            }
+
+            // Once extracted, delete the package if required.
+            if ( $delete_package ) {
+                unlink( $package );
+            }
+
+            return $return;
+        }
+    }
+
+    /**
+     * Run the class if found.
+     */
+    WP_Font_Awesome_Settings::instance();
 }