woocommerce / woocommerce-gateway-stripe

woocommerce-gateway-stripe.php

Spacing +123 added lines, -123 removed lines

@@ -25,20 +25,20 @@ 
  * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */
 
-if ( ! defined( 'ABSPATH' ) ) {
+if ( ! defined('ABSPATH')) {
 	exit;
 }
 
 /**
  * Required minimums and constants
  */
-define( 'WC_STRIPE_VERSION', '3.0.6' );
-define( 'WC_STRIPE_MIN_PHP_VER', '5.3.0' );
-define( 'WC_STRIPE_MIN_WC_VER', '2.5.0' );
-define( 'WC_STRIPE_MAIN_FILE', __FILE__ );
-define( 'WC_STRIPE_PLUGIN_URL', untrailingslashit( plugins_url( basename( plugin_dir_path( __FILE__ ) ), basename( __FILE__ ) ) ) );
+define('WC_STRIPE_VERSION', '3.0.6');
+define('WC_STRIPE_MIN_PHP_VER', '5.3.0');
+define('WC_STRIPE_MIN_WC_VER', '2.5.0');
+define('WC_STRIPE_MAIN_FILE', __FILE__);
+define('WC_STRIPE_PLUGIN_URL', untrailingslashit(plugins_url(basename(plugin_dir_path(__FILE__)), basename(__FILE__))));
 
-if ( ! class_exists( 'WC_Stripe' ) ) :
+if ( ! class_exists('WC_Stripe')) :
 
 	class WC_Stripe {
 
@@ -58,7 +58,7 @@ 
 		 * @return Singleton The *Singleton* instance.
 		 */
 		public static function get_instance() {
-			if ( null === self::$instance ) {
+			if (null === self::$instance) {
 				self::$instance = new self();
 			}
 			return self::$instance;
@@ -107,9 +107,9 @@ 
 		 * *Singleton* via the `new` operator from outside of this class.
 		 */
 		protected function __construct() {
-			add_action( 'admin_init', array( $this, 'check_environment' ) );
-			add_action( 'admin_notices', array( $this, 'admin_notices' ), 15 );
-			add_action( 'plugins_loaded', array( $this, 'init' ) );
+			add_action('admin_init', array($this, 'check_environment'));
+			add_action('admin_notices', array($this, 'admin_notices'), 15);
+			add_action('plugins_loaded', array($this, 'init'));
 		}
 
 		/**
@@ -117,33 +117,33 @@ 
 		 */
 		public function init() {
 			// Don't hook anything else in the plugin if we're in an incompatible environment
-			if ( self::get_environment_warning() ) {
+			if (self::get_environment_warning()) {
 				return;
 			}
 
-			include_once( dirname( __FILE__ ) . '/includes/class-wc-stripe-api.php' );
-			include_once( dirname( __FILE__ ) . '/includes/class-wc-stripe-customer.php' );
+			include_once(dirname(__FILE__) . '/includes/class-wc-stripe-api.php');
+			include_once(dirname(__FILE__) . '/includes/class-wc-stripe-customer.php');
 
 			// Init the gateway itself
 			$this->init_gateways();
 
-			add_filter( 'plugin_action_links_' . plugin_basename( __FILE__ ), array( $this, 'plugin_action_links' ) );
-			add_action( 'woocommerce_order_status_on-hold_to_processing', array( $this, 'capture_payment' ) );
-			add_action( 'woocommerce_order_status_on-hold_to_completed', array( $this, 'capture_payment' ) );
-			add_action( 'woocommerce_order_status_on-hold_to_cancelled', array( $this, 'cancel_payment' ) );
-			add_action( 'woocommerce_order_status_on-hold_to_refunded', array( $this, 'cancel_payment' ) );
-			add_filter( 'woocommerce_get_customer_payment_tokens', array( $this, 'woocommerce_get_customer_payment_tokens' ), 10, 3 );
-			add_action( 'woocommerce_payment_token_deleted', array( $this, 'woocommerce_payment_token_deleted' ), 10, 2 );
-			add_action( 'woocommerce_payment_token_set_default', array( $this, 'woocommerce_payment_token_set_default' ) );
+			add_filter('plugin_action_links_' . plugin_basename(__FILE__), array($this, 'plugin_action_links'));
+			add_action('woocommerce_order_status_on-hold_to_processing', array($this, 'capture_payment'));
+			add_action('woocommerce_order_status_on-hold_to_completed', array($this, 'capture_payment'));
+			add_action('woocommerce_order_status_on-hold_to_cancelled', array($this, 'cancel_payment'));
+			add_action('woocommerce_order_status_on-hold_to_refunded', array($this, 'cancel_payment'));
+			add_filter('woocommerce_get_customer_payment_tokens', array($this, 'woocommerce_get_customer_payment_tokens'), 10, 3);
+			add_action('woocommerce_payment_token_deleted', array($this, 'woocommerce_payment_token_deleted'), 10, 2);
+			add_action('woocommerce_payment_token_set_default', array($this, 'woocommerce_payment_token_set_default'));
 
-			include_once( dirname( __FILE__ ) . '/includes/class-wc-stripe-payment-request.php' );
+			include_once(dirname(__FILE__) . '/includes/class-wc-stripe-payment-request.php');
 		}
 
 		/**
 		 * Allow this class and other classes to add slug keyed notices (to avoid duplication)
 		 */
-		public function add_admin_notice( $slug, $class, $message ) {
-			$this->notices[ $slug ] = array(
+		public function add_admin_notice($slug, $class, $message) {
+			$this->notices[$slug] = array(
 				'class'   => $class,
 				'message' => $message,
 			);
@@ -156,21 +156,21 @@ 
 		public function check_environment() {
 			$environment_warning = self::get_environment_warning();
 
-			if ( $environment_warning && is_plugin_active( plugin_basename( __FILE__ ) ) ) {
-				$this->add_admin_notice( 'bad_environment', 'error', $environment_warning );
+			if ($environment_warning && is_plugin_active(plugin_basename(__FILE__))) {
+				$this->add_admin_notice('bad_environment', 'error', $environment_warning);
 			}
 
 			// Check if secret key present. Otherwise prompt, via notice, to go to
 			// setting.
-			if ( ! class_exists( 'WC_Stripe_API' ) ) {
-				include_once( dirname( __FILE__ ) . '/includes/class-wc-stripe-api.php' );
+			if ( ! class_exists('WC_Stripe_API')) {
+				include_once(dirname(__FILE__) . '/includes/class-wc-stripe-api.php');
 			}
 
 			$secret = WC_Stripe_API::get_secret_key();
 
-			if ( empty( $secret ) && ! ( isset( $_GET['page'], $_GET['section'] ) && 'wc-settings' === $_GET['page'] && 'stripe' === $_GET['section'] ) ) {
+			if (empty($secret) && ! (isset($_GET['page'], $_GET['section']) && 'wc-settings' === $_GET['page'] && 'stripe' === $_GET['section'])) {
 				$setting_link = $this->get_setting_link();
-				$this->add_admin_notice( 'prompt_connect', 'notice notice-warning', sprintf( __( 'Stripe is almost ready. To get started, <a href="%s">set your Stripe account keys</a>.', 'woocommerce-gateway-stripe' ), $setting_link ) );
+				$this->add_admin_notice('prompt_connect', 'notice notice-warning', sprintf(__('Stripe is almost ready. To get started, <a href="%s">set your Stripe account keys</a>.', 'woocommerce-gateway-stripe'), $setting_link));
 			}
 		}
 
@@ -179,24 +179,24 @@ 
 		 * found or false if the environment has no problems.
 		 */
 		static function get_environment_warning() {
-			if ( version_compare( phpversion(), WC_STRIPE_MIN_PHP_VER, '<' ) ) {
-				$message = __( 'WooCommerce Stripe - The minimum PHP version required for this plugin is %1$s. You are running %2$s.', 'woocommerce-gateway-stripe' );
+			if (version_compare(phpversion(), WC_STRIPE_MIN_PHP_VER, '<')) {
+				$message = __('WooCommerce Stripe - The minimum PHP version required for this plugin is %1$s. You are running %2$s.', 'woocommerce-gateway-stripe');
 
-				return sprintf( $message, WC_STRIPE_MIN_PHP_VER, phpversion() );
+				return sprintf($message, WC_STRIPE_MIN_PHP_VER, phpversion());
 			}
 
-			if ( ! defined( 'WC_VERSION' ) ) {
-				return __( 'WooCommerce Stripe requires WooCommerce to be activated to work.', 'woocommerce-gateway-stripe' );
+			if ( ! defined('WC_VERSION')) {
+				return __('WooCommerce Stripe requires WooCommerce to be activated to work.', 'woocommerce-gateway-stripe');
 			}
 
-			if ( version_compare( WC_VERSION, WC_STRIPE_MIN_WC_VER, '<' ) ) {
-				$message = __( 'WooCommerce Stripe - The minimum WooCommerce version required for this plugin is %1$s. You are running %2$s.', 'woocommerce-gateway-stripe' );
+			if (version_compare(WC_VERSION, WC_STRIPE_MIN_WC_VER, '<')) {
+				$message = __('WooCommerce Stripe - The minimum WooCommerce version required for this plugin is %1$s. You are running %2$s.', 'woocommerce-gateway-stripe');
 
-				return sprintf( $message, WC_STRIPE_MIN_WC_VER, WC_VERSION );
+				return sprintf($message, WC_STRIPE_MIN_WC_VER, WC_VERSION);
 			}
 
-			if ( ! function_exists( 'curl_init' ) ) {
-				return __( 'WooCommerce Stripe - cURL is not installed.', 'woocommerce-gateway-stripe' );
+			if ( ! function_exists('curl_init')) {
+				return __('WooCommerce Stripe - cURL is not installed.', 'woocommerce-gateway-stripe');
 			}
 
 			return false;
@@ -207,15 +207,15 @@ 
 		 *
 		 * @since 1.0.0
 		 */
-		public function plugin_action_links( $links ) {
+		public function plugin_action_links($links) {
 			$setting_link = $this->get_setting_link();
 
 			$plugin_links = array(
-				'<a href="' . $setting_link . '">' . __( 'Settings', 'woocommerce-gateway-stripe' ) . '</a>',
-				'<a href="https://docs.woothemes.com/document/stripe/">' . __( 'Docs', 'woocommerce-gateway-stripe' ) . '</a>',
-				'<a href="http://support.woothemes.com/">' . __( 'Support', 'woocommerce-gateway-stripe' ) . '</a>',
+				'<a href="' . $setting_link . '">' . __('Settings', 'woocommerce-gateway-stripe') . '</a>',
+				'<a href="https://docs.woothemes.com/document/stripe/">' . __('Docs', 'woocommerce-gateway-stripe') . '</a>',
+				'<a href="http://support.woothemes.com/">' . __('Support', 'woocommerce-gateway-stripe') . '</a>',
 			);
-			return array_merge( $plugin_links, $links );
+			return array_merge($plugin_links, $links);
 		}
 
 		/**
@@ -226,20 +226,20 @@ 
 		 * @return string Setting link
 		 */
 		public function get_setting_link() {
-			$use_id_as_section = function_exists( 'WC' ) ? version_compare( WC()->version, '2.6', '>=' ) : false;
+			$use_id_as_section = function_exists('WC') ? version_compare(WC()->version, '2.6', '>=') : false;
 
-			$section_slug = $use_id_as_section ? 'stripe' : strtolower( 'WC_Gateway_Stripe' );
+			$section_slug = $use_id_as_section ? 'stripe' : strtolower('WC_Gateway_Stripe');
 
-			return admin_url( 'admin.php?page=wc-settings&tab=checkout&section=' . $section_slug );
+			return admin_url('admin.php?page=wc-settings&tab=checkout&section=' . $section_slug);
 		}
 
 		/**
 		 * Display any notices we've collected thus far (e.g. for connection, disconnection)
 		 */
 		public function admin_notices() {
-			foreach ( (array) $this->notices as $notice_key => $notice ) {
-				echo "<div class='" . esc_attr( $notice['class'] ) . "'><p>";
-				echo wp_kses( $notice['message'], array( 'a' => array( 'href' => array() ) ) );
+			foreach ((array) $this->notices as $notice_key => $notice) {
+				echo "<div class='" . esc_attr($notice['class']) . "'><p>";
+				echo wp_kses($notice['message'], array('a' => array('href' => array())));
 				echo '</p></div>';
 			}
 		}
@@ -250,28 +250,28 @@ 
 		 * @since 1.0.0
 		 */
 		public function init_gateways() {
-			if ( class_exists( 'WC_Subscriptions_Order' ) && function_exists( 'wcs_create_renewal_order' ) ) {
+			if (class_exists('WC_Subscriptions_Order') && function_exists('wcs_create_renewal_order')) {
 				$this->subscription_support_enabled = true;
 			}
 
-			if ( class_exists( 'WC_Pre_Orders_Order' ) ) {
+			if (class_exists('WC_Pre_Orders_Order')) {
 				$this->pre_order_enabled = true;
 			}
 
-			if ( ! class_exists( 'WC_Payment_Gateway' ) ) {
+			if ( ! class_exists('WC_Payment_Gateway')) {
 				return;
 			}
 
-			if ( class_exists( 'WC_Payment_Gateway_CC' ) ) {
-				include_once( dirname( __FILE__ ) . '/includes/class-wc-gateway-stripe.php' );
-				include_once( dirname( __FILE__ ) . '/includes/class-wc-stripe-apple-pay.php' );
+			if (class_exists('WC_Payment_Gateway_CC')) {
+				include_once(dirname(__FILE__) . '/includes/class-wc-gateway-stripe.php');
+				include_once(dirname(__FILE__) . '/includes/class-wc-stripe-apple-pay.php');
 			} else {
-				include_once( dirname( __FILE__ ) . '/includes/legacy/class-wc-gateway-stripe.php' );
-				include_once( dirname( __FILE__ ) . '/includes/legacy/class-wc-gateway-stripe-saved-cards.php' );
+				include_once(dirname(__FILE__) . '/includes/legacy/class-wc-gateway-stripe.php');
+				include_once(dirname(__FILE__) . '/includes/legacy/class-wc-gateway-stripe-saved-cards.php');
 			}
 
-			load_plugin_textdomain( 'woocommerce-gateway-stripe', false, plugin_basename( dirname( __FILE__ ) ) . '/languages' );
-			add_filter( 'woocommerce_payment_gateways', array( $this, 'add_gateways' ) );
+			load_plugin_textdomain('woocommerce-gateway-stripe', false, plugin_basename(dirname(__FILE__)) . '/languages');
+			add_filter('woocommerce_payment_gateways', array($this, 'add_gateways'));
 
 			$load_addons = (
 				$this->subscription_support_enabled
@@ -279,8 +279,8 @@ 
 				$this->pre_order_enabled
 			);
 
-			if ( $load_addons ) {
-				require_once( dirname( __FILE__ ) . '/includes/class-wc-gateway-stripe-addons.php' );
+			if ($load_addons) {
+				require_once(dirname(__FILE__) . '/includes/class-wc-gateway-stripe-addons.php');
 			}
 		}
 
@@ -289,8 +289,8 @@ 
 		 *
 		 * @since 1.0.0
 		 */
-		public function add_gateways( $methods ) {
-			if ( $this->subscription_support_enabled || $this->pre_order_enabled ) {
+		public function add_gateways($methods) {
+			if ($this->subscription_support_enabled || $this->pre_order_enabled) {
 				$methods[] = 'WC_Gateway_Stripe_Addons';
 			} else {
 				$methods[] = 'WC_Gateway_Stripe';
@@ -303,35 +303,35 @@ 
 		 *
 		 * @param  int $order_id
 		 */
-		public function capture_payment( $order_id ) {
-			$order = wc_get_order( $order_id );
+		public function capture_payment($order_id) {
+			$order = wc_get_order($order_id);
 
-			if ( 'stripe' === $order->payment_method ) {
-				$charge   = get_post_meta( $order_id, '_stripe_charge_id', true );
-				$captured = get_post_meta( $order_id, '_stripe_charge_captured', true );
+			if ('stripe' === $order->payment_method) {
+				$charge   = get_post_meta($order_id, '_stripe_charge_id', true);
+				$captured = get_post_meta($order_id, '_stripe_charge_captured', true);
 
-				if ( $charge && 'no' === $captured ) {
-					$result = WC_Stripe_API::request( array(
+				if ($charge && 'no' === $captured) {
+					$result = WC_Stripe_API::request(array(
 						'amount'   => $order->get_total() * 100,
 						'expand[]' => 'balance_transaction',
-					), 'charges/' . $charge . '/capture' );
+					), 'charges/' . $charge . '/capture');
 
-					if ( is_wp_error( $result ) ) {
-						$order->add_order_note( __( 'Unable to capture charge!', 'woocommerce-gateway-stripe' ) . ' ' . $result->get_error_message() );
+					if (is_wp_error($result)) {
+						$order->add_order_note(__('Unable to capture charge!', 'woocommerce-gateway-stripe') . ' ' . $result->get_error_message());
 					} else {
-						$order->add_order_note( sprintf( __( 'Stripe charge complete (Charge ID: %s)', 'woocommerce-gateway-stripe' ), $result->id ) );
-						update_post_meta( $order->id, '_stripe_charge_captured', 'yes' );
+						$order->add_order_note(sprintf(__('Stripe charge complete (Charge ID: %s)', 'woocommerce-gateway-stripe'), $result->id));
+						update_post_meta($order->id, '_stripe_charge_captured', 'yes');
 
 						// Store other data such as fees
-						update_post_meta( $order->id, 'Stripe Payment ID', $result->id );
+						update_post_meta($order->id, 'Stripe Payment ID', $result->id);
 
-						if ( isset( $result->balance_transaction ) && isset( $result->balance_transaction->fee ) ) {
+						if (isset($result->balance_transaction) && isset($result->balance_transaction->fee)) {
 							// Fees and Net needs to both come from Stripe to be accurate as the returned
 							// values are in the local currency of the Stripe account, not from WC.
-							$fee = ! empty( $result->balance_transaction->fee ) ? number_format( $result->balance_transaction->fee / 100, 2, '.', '' ) : 0;
-							$net = ! empty( $result->balance_transaction->net ) ? number_format( $result->balance_transaction->net / 100, 2, '.', '' ) : 0;
-							update_post_meta( $order->id, 'Stripe Fee', $fee );
-							update_post_meta( $order->id, 'Net Revenue From Stripe', $net );
+							$fee = ! empty($result->balance_transaction->fee) ? number_format($result->balance_transaction->fee / 100, 2, '.', '') : 0;
+							$net = ! empty($result->balance_transaction->net) ? number_format($result->balance_transaction->net / 100, 2, '.', '') : 0;
+							update_post_meta($order->id, 'Stripe Fee', $fee);
+							update_post_meta($order->id, 'Net Revenue From Stripe', $net);
 						}
 					}
 				}
@@ -343,23 +343,23 @@ 
 		 *
 		 * @param  int $order_id
 		 */
-		public function cancel_payment( $order_id ) {
-			$order = wc_get_order( $order_id );
+		public function cancel_payment($order_id) {
+			$order = wc_get_order($order_id);
 
-			if ( 'stripe' === $order->payment_method ) {
-				$charge   = get_post_meta( $order_id, '_stripe_charge_id', true );
+			if ('stripe' === $order->payment_method) {
+				$charge = get_post_meta($order_id, '_stripe_charge_id', true);
 
-				if ( $charge ) {
-					$result = WC_Stripe_API::request( array(
+				if ($charge) {
+					$result = WC_Stripe_API::request(array(
 						'amount' => $order->get_total() * 100,
-					), 'charges/' . $charge . '/refund' );
+					), 'charges/' . $charge . '/refund');
 
-					if ( is_wp_error( $result ) ) {
-						$order->add_order_note( __( 'Unable to refund charge!', 'woocommerce-gateway-stripe' ) . ' ' . $result->get_error_message() );
+					if (is_wp_error($result)) {
+						$order->add_order_note(__('Unable to refund charge!', 'woocommerce-gateway-stripe') . ' ' . $result->get_error_message());
 					} else {
-						$order->add_order_note( sprintf( __( 'Stripe charge refunded (Charge ID: %s)', 'woocommerce-gateway-stripe' ), $result->id ) );
-						delete_post_meta( $order->id, '_stripe_charge_captured' );
-						delete_post_meta( $order->id, '_stripe_charge_id' );
+						$order->add_order_note(sprintf(__('Stripe charge refunded (Charge ID: %s)', 'woocommerce-gateway-stripe'), $result->id));
+						delete_post_meta($order->id, '_stripe_charge_captured');
+						delete_post_meta($order->id, '_stripe_charge_id');
 					}
 				}
 			}
@@ -370,28 +370,28 @@ 
 		 * @param array $tokens
 		 * @return array
 		 */
-		public function woocommerce_get_customer_payment_tokens( $tokens, $customer_id, $gateway_id ) {
-			if ( is_user_logged_in() && 'stripe' === $gateway_id && class_exists( 'WC_Payment_Token_CC' ) ) {
-				$stripe_customer = new WC_Stripe_Customer( $customer_id );
+		public function woocommerce_get_customer_payment_tokens($tokens, $customer_id, $gateway_id) {
+			if (is_user_logged_in() && 'stripe' === $gateway_id && class_exists('WC_Payment_Token_CC')) {
+				$stripe_customer = new WC_Stripe_Customer($customer_id);
 				$stripe_cards    = $stripe_customer->get_cards();
 				$stored_tokens   = array();
 
-				foreach ( $tokens as $token ) {
+				foreach ($tokens as $token) {
 					$stored_tokens[] = $token->get_token();
 				}
 
-				foreach ( $stripe_cards as $card ) {
-					if ( ! in_array( $card->id, $stored_tokens ) ) {
+				foreach ($stripe_cards as $card) {
+					if ( ! in_array($card->id, $stored_tokens)) {
 						$token = new WC_Payment_Token_CC();
-						$token->set_token( $card->id );
-						$token->set_gateway_id( 'stripe' );
-						$token->set_card_type( strtolower( $card->brand ) );
-						$token->set_last4( $card->last4 );
-						$token->set_expiry_month( $card->exp_month );
-						$token->set_expiry_year( $card->exp_year );
-						$token->set_user_id( $customer_id );
+						$token->set_token($card->id);
+						$token->set_gateway_id('stripe');
+						$token->set_card_type(strtolower($card->brand));
+						$token->set_last4($card->last4);
+						$token->set_expiry_month($card->exp_month);
+						$token->set_expiry_year($card->exp_year);
+						$token->set_user_id($customer_id);
 						$token->save();
-						$tokens[ $token->get_id() ] = $token;
+						$tokens[$token->get_id()] = $token;
 					}
 				}
 			}
@@ -401,21 +401,21 @@ 
 		/**
 		 * Delete token from Stripe
 		 */
-		public function woocommerce_payment_token_deleted( $token_id, $token ) {
-			if ( 'stripe' === $token->get_gateway_id() ) {
-				$stripe_customer = new WC_Stripe_Customer( get_current_user_id() );
-				$stripe_customer->delete_card( $token->get_token() );
+		public function woocommerce_payment_token_deleted($token_id, $token) {
+			if ('stripe' === $token->get_gateway_id()) {
+				$stripe_customer = new WC_Stripe_Customer(get_current_user_id());
+				$stripe_customer->delete_card($token->get_token());
 			}
 		}
 
 		/**
 		 * Set as default in Stripe
 		 */
-		public function woocommerce_payment_token_set_default( $token_id ) {
-			$token = WC_Payment_Tokens::get( $token_id );
-			if ( 'stripe' === $token->get_gateway_id() ) {
-				$stripe_customer = new WC_Stripe_Customer( get_current_user_id() );
-				$stripe_customer->set_default_card( $token->get_token() );
+		public function woocommerce_payment_token_set_default($token_id) {
+			$token = WC_Payment_Tokens::get($token_id);
+			if ('stripe' === $token->get_gateway_id()) {
+				$stripe_customer = new WC_Stripe_Customer(get_current_user_id());
+				$stripe_customer->set_default_card($token->get_token());
 			}
 		}
 
@@ -424,7 +424,7 @@ 
 		 */
 		public static function get_minimum_amount() {
 			// Check order amount
-			switch ( get_woocommerce_currency() ) {
+			switch (get_woocommerce_currency()) {
 				case 'USD':
 				case 'CAD':
 				case 'EUR':
@@ -468,12 +468,12 @@ 
 		 * And fits on your back?
 		 * It's log, log, log
 		 */
-		public static function log( $message ) {
-			if ( empty( self::$log ) ) {
+		public static function log($message) {
+			if (empty(self::$log)) {
 				self::$log = new WC_Logger();
 			}
 
-			self::$log->add( 'woocommerce-gateway-stripe', $message );
+			self::$log->add('woocommerce-gateway-stripe', $message);
 		}
 	}