AyeCode / invoicing

includes/gateways/class-getpaid-bank-transfer-gateway.php

Spacing +109 added lines, -109 removed lines

@@ -4,7 +4,7 @@ 
  *
  */
 
-defined( 'ABSPATH' ) || exit;
+defined('ABSPATH') || exit;
 
 /**
  * Bank transfer Payment Gateway class.
@@ -56,21 +56,21 @@ 
 	public function __construct() {
         parent::__construct();
 
-        $this->title                = __( 'Direct bank transfer', 'invoicing' );
-        $this->method_title         = __( 'Bank transfer', 'invoicing' );
-        $this->checkout_button_text = __( 'Proceed', 'invoicing' );
-        $this->instructions         = apply_filters( 'wpinv_bank_instructions', $this->get_option( 'info' ) );
-
-		add_action( 'wpinv_receipt_end', array( $this, 'thankyou_page' ) );
-		add_action( 'getpaid_invoice_line_items', array( $this, 'thankyou_page' ), 40 );
-		add_action( 'wpinv_pdf_content_billing', array( $this, 'thankyou_page' ), 11 );
-		add_action( 'wpinv_email_invoice_details', array( $this, 'email_instructions' ), 10, 3 );
-		add_action( 'getpaid_should_renew_subscription', array( $this, 'maybe_renew_subscription' ), 12, 2 );
-		add_action( 'getpaid_invoice_status_publish', array( $this, 'invoice_paid' ), 20 );
-
-		add_filter( 'wpinv_' . $this->id . '_support_subscription', array( $this, 'supports_subscription' ), 20, 1 );
-		add_filter( 'getpaid_' . $this->id . '_support_subscription', array( $this, 'supports_subscription' ), 20, 1 );
-		add_filter( 'getpaid_' . $this->id . '_supports_subscription', array( $this, 'supports_subscription' ), 20, 1 );
+        $this->title                = __('Direct bank transfer', 'invoicing');
+        $this->method_title         = __('Bank transfer', 'invoicing');
+        $this->checkout_button_text = __('Proceed', 'invoicing');
+        $this->instructions         = apply_filters('wpinv_bank_instructions', $this->get_option('info'));
+
+		add_action('wpinv_receipt_end', array($this, 'thankyou_page'));
+		add_action('getpaid_invoice_line_items', array($this, 'thankyou_page'), 40);
+		add_action('wpinv_pdf_content_billing', array($this, 'thankyou_page'), 11);
+		add_action('wpinv_email_invoice_details', array($this, 'email_instructions'), 10, 3);
+		add_action('getpaid_should_renew_subscription', array($this, 'maybe_renew_subscription'), 12, 2);
+		add_action('getpaid_invoice_status_publish', array($this, 'invoice_paid'), 20);
+
+		add_filter('wpinv_' . $this->id . '_support_subscription', array($this, 'supports_subscription'), 20, 1);
+		add_filter('getpaid_' . $this->id . '_support_subscription', array($this, 'supports_subscription'), 20, 1);
+		add_filter('getpaid_' . $this->id . '_supports_subscription', array($this, 'supports_subscription'), 20, 1);
 	}
 
 	/**
@@ -81,8 +81,8 @@ 
 	 * @param bool $supports True if supports else False.
 	 * @return bool True if supports else False.
 	 */
-	public function supports_subscription( $supports ) {
-		if ( $supports && (int) $this->get_option( 'no_subscription' ) ) {
+	public function supports_subscription($supports) {
+		if ($supports && (int) $this->get_option('no_subscription')) {
 			$supports = false;
 		}
 
@@ -97,23 +97,23 @@ 
 	 * @param GetPaid_Payment_Form_Submission $submission Checkout submission.
 	 * @return array
 	 */
-	public function process_payment( $invoice, $submission_data, $submission ) {
+	public function process_payment($invoice, $submission_data, $submission) {
 
         // Add a transaction id.
-        $invoice->set_transaction_id( $invoice->generate_key( 'bt_' ) );
+        $invoice->set_transaction_id($invoice->generate_key('bt_'));
 
         // Set it as pending payment.
-        if ( ! $invoice->needs_payment() ) {
+        if (!$invoice->needs_payment()) {
             $invoice->mark_paid();
-        } elseif ( ! $invoice->is_paid() ) {
-            $invoice->set_status( 'wpi-onhold' );
+        } elseif (!$invoice->is_paid()) {
+            $invoice->set_status('wpi-onhold');
         }
 
         // Save it.
         $invoice->save();
 
         // Send to the success page.
-        wpinv_send_to_success_page( array( 'invoice_key' => $invoice->get_key() ) );
+        wpinv_send_to_success_page(array('invoice_key' => $invoice->get_key()));
 
     }
 
@@ -122,17 +122,17 @@ 
 	 *
 	 * @param WPInv_Invoice $invoice Invoice.
 	 */
-	public function thankyou_page( $invoice ) {
+	public function thankyou_page($invoice) {
 
-        if ( 'bank_transfer' === $invoice->get_gateway() && $invoice->needs_payment() ) {
+        if ('bank_transfer' === $invoice->get_gateway() && $invoice->needs_payment()) {
 
 			echo '<div class="mt-4 mb-2 getpaid-bank-transfer-details">' . PHP_EOL;
 
-            if ( ! empty( $this->instructions ) ) {
-                echo wp_kses_post( wpautop( wptexturize( $this->instructions ) ) );
+            if (!empty($this->instructions)) {
+                echo wp_kses_post(wpautop(wptexturize($this->instructions)));
 			}
 
-			$this->bank_details( $invoice );
+			$this->bank_details($invoice);
 
 			echo '</div>';
 
@@ -147,17 +147,17 @@ 
 	 * @param string     $email_type Email format: plain text or HTML.
 	 * @param bool     $sent_to_admin Sent to admin.
 	 */
-	public function email_instructions( $invoice, $email_type, $sent_to_admin ) {
+	public function email_instructions($invoice, $email_type, $sent_to_admin) {
 
-		if ( ! $sent_to_admin && 'bank_transfer' === $invoice->get_gateway() && $invoice->needs_payment() ) {
+		if (!$sent_to_admin && 'bank_transfer' === $invoice->get_gateway() && $invoice->needs_payment()) {
 
 			echo '<div class="wpi-email-row getpaid-bank-transfer-details">';
 
-			if ( $this->instructions ) {
-				echo wp_kses_post( wpautop( wptexturize( $this->instructions ) ) . PHP_EOL );
+			if ($this->instructions) {
+				echo wp_kses_post(wpautop(wptexturize($this->instructions)) . PHP_EOL);
             }
 
-			$this->bank_details( $invoice );
+			$this->bank_details($invoice);
 
 			echo '</div>';
 
@@ -170,50 +170,50 @@ 
 	 *
 	 * @param WPInv_Invoice $invoice Invoice.
 	 */
-	protected function bank_details( $invoice ) {
+	protected function bank_details($invoice) {
 
 		// Get the invoice country and country $locale.
 		$country = $invoice->get_country();
 		$locale  = $this->get_country_locale();
 
 		// Get shortcode label in the $locale array and use appropriate one.
-		$sortcode = isset( $locale[ $country ]['sortcode']['label'] ) ? $locale[ $country ]['sortcode']['label'] : __( 'Sort code', 'invoicing' );
+		$sortcode = isset($locale[$country]['sortcode']['label']) ? $locale[$country]['sortcode']['label'] : __('Sort code', 'invoicing');
 
         $bank_fields = array(
-            'ac_name'   => __( 'Account Name', 'invoicing' ),
-            'ac_no'     => __( 'Account Number', 'invoicing' ),
-            'bank_name' => __( 'Bank Name', 'invoicing' ),
-            'ifsc'      => __( 'IFSC code', 'invoicing' ),
-            'iban'      => __( 'IBAN', 'invoicing' ),
-            'bic'       => __( 'BIC/Swift code', 'invoicing' ),
+            'ac_name'   => __('Account Name', 'invoicing'),
+            'ac_no'     => __('Account Number', 'invoicing'),
+            'bank_name' => __('Bank Name', 'invoicing'),
+            'ifsc'      => __('IFSC code', 'invoicing'),
+            'iban'      => __('IBAN', 'invoicing'),
+            'bic'       => __('BIC/Swift code', 'invoicing'),
             'sort_code' => $sortcode,
         );
 
         $bank_info = array();
 
-        foreach ( $bank_fields as $field => $label ) {
-            $value = $this->get_option( $field );
+        foreach ($bank_fields as $field => $label) {
+            $value = $this->get_option($field);
 
-            if ( ! empty( $value ) ) {
-                $bank_info[ $field ] = array(
+            if (!empty($value)) {
+                $bank_info[$field] = array(
 					'label' => $label,
 					'value' => $value,
 				);
             }
 		}
 
-        $bank_info = apply_filters( 'wpinv_bank_info', $bank_info, $invoice );
+        $bank_info = apply_filters('wpinv_bank_info', $bank_info, $invoice);
 
-        if ( empty( $bank_info ) ) {
+        if (empty($bank_info)) {
             return;
         }
 
-		echo '<h3 class="getpaid-bank-transfer-title"> ' . esc_html( apply_filters( 'wpinv_receipt_bank_details_title', __( 'Bank Details', 'invoicing' ), $invoice ) ) . '</h3>' . PHP_EOL;
+		echo '<h3 class="getpaid-bank-transfer-title"> ' . esc_html(apply_filters('wpinv_receipt_bank_details_title', __('Bank Details', 'invoicing'), $invoice)) . '</h3>' . PHP_EOL;
 
 		echo '<table class="table table-bordered getpaid-bank-transfer-details">' . PHP_EOL;
 
-		foreach ( $bank_info as $key => $data ) {
-			echo "<tr class='getpaid-bank-transfer-" . esc_attr( $key ) . "'><th class='font-weight-bold'>" . wp_kses_post( $data['label'] ) . "</th><td class='w-75'>" . wp_kses_post( wptexturize( $data['value'] ) ) . '</td></tr>' . PHP_EOL;
+		foreach ($bank_info as $key => $data) {
+			echo "<tr class='getpaid-bank-transfer-" . esc_attr($key) . "'><th class='font-weight-bold'>" . wp_kses_post($data['label']) . "</th><td class='w-75'>" . wp_kses_post(wptexturize($data['value'])) . '</td></tr>' . PHP_EOL;
 		}
 
 		echo '</table>';
@@ -227,7 +227,7 @@ 
 	 */
 	public function get_country_locale() {
 
-		if ( empty( $this->locale ) ) {
+		if (empty($this->locale)) {
 
 			// Locale information to be used - only those that are not 'Sort Code'.
 			$this->locale = apply_filters(
@@ -235,42 +235,42 @@ 
 				array(
 					'AU' => array(
 						'sortcode' => array(
-							'label' => __( 'BSB', 'invoicing' ),
+							'label' => __('BSB', 'invoicing'),
 						),
 					),
 					'CA' => array(
 						'sortcode' => array(
-							'label' => __( 'Bank transit number', 'invoicing' ),
+							'label' => __('Bank transit number', 'invoicing'),
 						),
 					),
 					'IN' => array(
 						'sortcode' => array(
-							'label' => __( 'IFSC', 'invoicing' ),
+							'label' => __('IFSC', 'invoicing'),
 						),
 					),
 					'IT' => array(
 						'sortcode' => array(
-							'label' => __( 'Branch sort', 'invoicing' ),
+							'label' => __('Branch sort', 'invoicing'),
 						),
 					),
 					'NZ' => array(
 						'sortcode' => array(
-							'label' => __( 'Bank code', 'invoicing' ),
+							'label' => __('Bank code', 'invoicing'),
 						),
 					),
 					'SE' => array(
 						'sortcode' => array(
-							'label' => __( 'Bank code', 'invoicing' ),
+							'label' => __('Bank code', 'invoicing'),
 						),
 					),
 					'US' => array(
 						'sortcode' => array(
-							'label' => __( 'Routing number', 'invoicing' ),
+							'label' => __('Routing number', 'invoicing'),
 						),
 					),
 					'ZA' => array(
 						'sortcode' => array(
-							'label' => __( 'Branch code', 'invoicing' ),
+							'label' => __('Branch code', 'invoicing'),
 						),
 					),
 				)
@@ -287,22 +287,22 @@ 
 	 *
 	 * @param array $admin_settings
 	 */
-	public function admin_settings( $admin_settings ) {
-		$admin_settings['bank_transfer_desc']['std']    = __( "Make your payment directly into our bank account. Please use your Invoice Number as the payment reference. Your invoice won't be processed until the funds have cleared in our account.", 'invoicing' );
-		$admin_settings['bank_transfer_active']['desc'] = __( 'Enable bank transfer', 'invoicing' );
+	public function admin_settings($admin_settings) {
+		$admin_settings['bank_transfer_desc']['std']    = __("Make your payment directly into our bank account. Please use your Invoice Number as the payment reference. Your invoice won't be processed until the funds have cleared in our account.", 'invoicing');
+		$admin_settings['bank_transfer_active']['desc'] = __('Enable bank transfer', 'invoicing');
 
 		$_settings = array();
 
-		foreach ( $admin_settings as $key => $setting ) {
-			$_settings[ $key ] = $setting;
+		foreach ($admin_settings as $key => $setting) {
+			$_settings[$key] = $setting;
 
-			if ( $key == 'bank_transfer_active' ) {
+			if ($key == 'bank_transfer_active') {
 				// Enable/disable subscriptions setting.
 				$_settings['bank_transfer_no_subscription'] = array(
 					'id' => 'bank_transfer_no_subscription',
 					'type' => 'checkbox',
-					'name' => __( 'Disable Subscriptions', 'invoicing' ),
-					'desc' => __( 'Tick to disable support for recurring items.', 'invoicing' ),
+					'name' => __('Disable Subscriptions', 'invoicing'),
+					'desc' => __('Tick to disable support for recurring items.', 'invoicing'),
 					'std' => 0
 				);
 			}
@@ -310,46 +310,46 @@ 
 
 		$admin_settings = $_settings;
 
-		$locale  = $this->get_country_locale();
+		$locale = $this->get_country_locale();
 
 		// Get sortcode label in the $locale array and use appropriate one.
 		$country  = wpinv_default_billing_country();
-		$sortcode = isset( $locale[ $country ]['sortcode']['label'] ) ? $locale[ $country ]['sortcode']['label'] : __( 'Sort code', 'invoicing' );
+		$sortcode = isset($locale[$country]['sortcode']['label']) ? $locale[$country]['sortcode']['label'] : __('Sort code', 'invoicing');
 
 		$admin_settings['bank_transfer_ac_name'] = array(
 			'type' => 'text',
 			'id'   => 'bank_transfer_ac_name',
-			'name' => __( 'Account Name', 'invoicing' ),
+			'name' => __('Account Name', 'invoicing'),
 		);
 
 		$admin_settings['bank_transfer_ac_no'] = array(
 			'type' => 'text',
 			'id'   => 'bank_transfer_ac_no',
-			'name' => __( 'Account Number', 'invoicing' ),
+			'name' => __('Account Number', 'invoicing'),
 		);
 
 		$admin_settings['bank_transfer_bank_name'] = array(
 			'type' => 'text',
 			'id'   => 'bank_transfer_bank_name',
-			'name' => __( 'Bank Name', 'invoicing' ),
+			'name' => __('Bank Name', 'invoicing'),
 		);
 
 		$admin_settings['bank_transfer_ifsc'] = array(
 			'type' => 'text',
 			'id'   => 'bank_transfer_ifsc',
-			'name' => __( 'IFSC Code', 'invoicing' ),
+			'name' => __('IFSC Code', 'invoicing'),
 		);
 
 		$admin_settings['bank_transfer_iban'] = array(
 			'type' => 'text',
 			'id'   => 'bank_transfer_iban',
-			'name' => __( 'IBAN', 'invoicing' ),
+			'name' => __('IBAN', 'invoicing'),
 		);
 
 		$admin_settings['bank_transfer_bic'] = array(
 			'type' => 'text',
 			'id'   => 'bank_transfer_bic',
-			'name' => __( 'BIC/Swift Code', 'invoicing' ),
+			'name' => __('BIC/Swift Code', 'invoicing'),
 		);
 
 		$admin_settings['bank_transfer_sort_code'] = array(
@@ -360,10 +360,10 @@ 
 
 		$admin_settings['bank_transfer_info'] = array(
 			'id'   => 'bank_transfer_info',
-			'name' => __( 'Instructions', 'invoicing' ),
-			'desc' => __( 'Instructions that will be added to the thank you page and emails.', 'invoicing' ),
+			'name' => __('Instructions', 'invoicing'),
+			'desc' => __('Instructions that will be added to the thank you page and emails.', 'invoicing'),
 			'type' => 'textarea',
-			'std'  => __( "Make your payment directly into our bank account. Please use your Invoice Number as the payment reference. Your invoice won't be processed until the funds have cleared in our account.", 'invoicing' ),
+			'std'  => __("Make your payment directly into our bank account. Please use your Invoice Number as the payment reference. Your invoice won't be processed until the funds have cleared in our account.", 'invoicing'),
 			'cols' => 50,
 			'rows' => 5,
 		);
@@ -378,10 +378,10 @@ 
 	 * @param GetPaid_Form_Item[] $items
 	 * @return WPInv_Invoice
 	 */
-	public function process_addons( $invoice, $items ) {
+	public function process_addons($invoice, $items) {
 
-        foreach ( $items as $item ) {
-            $invoice->add_item( $item );
+        foreach ($items as $item) {
+            $invoice->add_item($item);
         }
 
         $invoice->recalculate_total();
@@ -394,25 +394,25 @@ 
 	 *
 	 * @param WPInv_Subscription $subscription
 	 */
-	public function maybe_renew_subscription( $subscription, $parent_invoice ) {
+	public function maybe_renew_subscription($subscription, $parent_invoice) {
 		// Ensure its our subscription && it's active.
-		if ( ! empty( $parent_invoice ) && $this->id === $parent_invoice->get_gateway() && $subscription->has_status( 'active trialling' ) ) {
-			add_filter( 'getpaid_invoice_notifications_is_payment_form_invoice', array( $this, 'force_is_payment_form_invoice' ), 10, 2 );
+		if (!empty($parent_invoice) && $this->id === $parent_invoice->get_gateway() && $subscription->has_status('active trialling')) {
+			add_filter('getpaid_invoice_notifications_is_payment_form_invoice', array($this, 'force_is_payment_form_invoice'), 10, 2);
 
 			$invoice = $subscription->create_payment();
 
-			if ( ! empty( $invoice ) ) {
+			if (!empty($invoice)) {
 				$is_logged_in = is_user_logged_in();
 
 				// Cron run.
-				if ( ! $is_logged_in ) {
-					$note = wp_sprintf( __( 'Renewal %1$s created with the status "%2$s".', 'invoicing' ), $invoice->get_invoice_quote_type(), wpinv_status_nicename( $invoice->get_status(), $invoice ) );
+				if (!$is_logged_in) {
+					$note = wp_sprintf(__('Renewal %1$s created with the status "%2$s".', 'invoicing'), $invoice->get_invoice_quote_type(), wpinv_status_nicename($invoice->get_status(), $invoice));
 
-					$invoice->add_note( $note, false, $is_logged_in, ! $is_logged_in );
+					$invoice->add_note($note, false, $is_logged_in, !$is_logged_in);
 				}
 			}
 
-			remove_filter( 'getpaid_invoice_notifications_is_payment_form_invoice', array( $this, 'force_is_payment_form_invoice' ), 10, 2 );
+			remove_filter('getpaid_invoice_notifications_is_payment_form_invoice', array($this, 'force_is_payment_form_invoice'), 10, 2);
 		}
 	}
 
@@ -422,42 +422,42 @@ 
 	 *
      * @param WPInv_Invoice $invoice
 	 */
-	public function invoice_paid( $invoice ) {
+	public function invoice_paid($invoice) {
 
 		// Abort if not paid by bank transfer.
-		if ( $this->id !== $invoice->get_gateway() || ! $invoice->is_recurring() ) {
+		if ($this->id !== $invoice->get_gateway() || !$invoice->is_recurring()) {
 			return;
 		}
 
 		// Is it a parent payment?
-		if ( 0 == $invoice->get_parent_id() ) {
+		if (0 == $invoice->get_parent_id()) {
 
 			// (Maybe) activate subscriptions.
-			$subscriptions = getpaid_get_invoice_subscriptions( $invoice );
+			$subscriptions = getpaid_get_invoice_subscriptions($invoice);
 
-			if ( ! empty( $subscriptions ) ) {
-				$subscriptions = is_array( $subscriptions ) ? $subscriptions : array( $subscriptions );
+			if (!empty($subscriptions)) {
+				$subscriptions = is_array($subscriptions) ? $subscriptions : array($subscriptions);
 
-				foreach ( $subscriptions as $subscription ) {
-					if ( $subscription->exists() ) {
-						$duration = strtotime( $subscription->get_expiration() ) - strtotime( $subscription->get_date_created() );
-						$expiry   = gmdate( 'Y-m-d H:i:s', ( current_time( 'timestamp' ) + $duration ) );
+				foreach ($subscriptions as $subscription) {
+					if ($subscription->exists()) {
+						$duration = strtotime($subscription->get_expiration()) - strtotime($subscription->get_date_created());
+						$expiry   = gmdate('Y-m-d H:i:s', (current_time('timestamp') + $duration));
 
-						$subscription->set_next_renewal_date( $expiry );
-						$subscription->set_date_created( current_time( 'mysql' ) );
-						$subscription->set_profile_id( 'bt_sub_' . $invoice->get_id() . '_' . $subscription->get_id() );
+						$subscription->set_next_renewal_date($expiry);
+						$subscription->set_date_created(current_time('mysql'));
+						$subscription->set_profile_id('bt_sub_' . $invoice->get_id() . '_' . $subscription->get_id());
 						$subscription->activate();
 					}
 				}
 			}
 		} else {
 
-			$subscription = getpaid_get_subscription( $invoice->get_subscription_id() );
+			$subscription = getpaid_get_subscription($invoice->get_subscription_id());
 
 			// Renew the subscription.
-			if ( $subscription && $subscription->exists() ) {
-				$subscription->add_payment( array(), $invoice );
-				$subscription->renew( strtotime( $invoice->get_date_created() ) );
+			if ($subscription && $subscription->exists()) {
+				$subscription->add_payment(array(), $invoice);
+				$subscription->renew(strtotime($invoice->get_date_created()));
 			}
 		}
 
@@ -472,8 +472,8 @@ 
 	 * @param int  $invoice Invoice ID.
 	 * @return bool True when invoice created via payment form else false.
 	 */
-	public function force_is_payment_form_invoice( $is_payment_form_invoice, $invoice ) {
-		if ( $is_payment_form_invoice ) {
+	public function force_is_payment_form_invoice($is_payment_form_invoice, $invoice) {
+		if ($is_payment_form_invoice) {
 			$is_payment_form_invoice = false;
 		}