Completed
Pull Request — master (#1357)
by
unknown
01:56
created

woocommerce-gateway-stripe.php ➔ wc_stripe()   B

Complexity

Conditions 2
Paths 2

Size

Total Lines 296

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 2
nc 2
nop 0
dl 0
loc 296
rs 8
c 0
b 0
f 0

13 Methods

Rating   Name   Duplication   Size   Complexity  
A WC_Stripe::get_instance() 0 6 2
A WC_Stripe::__clone() 0 1 1
A WC_Stripe::__wakeup() 0 1 1
A WC_Stripe::__construct() 0 10 1
A WC_Stripe::init() 0 52 4
A WC_Stripe::update_plugin_version() 0 4 1
A WC_Stripe::install() 0 15 5
A WC_Stripe::plugin_action_links() 0 6 1
A WC_Stripe::plugin_row_meta() 0 10 2
A WC_Stripe::add_gateways() 0 20 3
A WC_Stripe::filter_gateway_order_admin() 0 25 1
A WC_Stripe::add_emails() 0 13 1
A WC_Stripe::register_connect_routes() 0 12 1

How to fix   Long Method   

Long Method

Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.

For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.

Commonly applied refactorings include:

1
<?php
2
/**
3
 * Plugin Name: WooCommerce Stripe Gateway
4
 * Plugin URI: https://wordpress.org/plugins/woocommerce-gateway-stripe/
5
 * Description: Take credit card payments on your store using Stripe.
6
 * Author: WooCommerce
7
 * Author URI: https://woocommerce.com/
8
 * Version: 4.5.3
9
 * Requires at least: 4.4
10
 * Tested up to: 5.5
11
 * WC requires at least: 3.0
12
 * WC tested up to: 4.3
13
 * Text Domain: woocommerce-gateway-stripe
14
 * Domain Path: /languages
15
 *
16
 */
17
18
if ( ! defined( 'ABSPATH' ) ) {
19
	exit;
20
}
21
22
/**
23
 * Required minimums and constants
24
 */
25
define( 'WC_STRIPE_VERSION', '4.5.3' ); // WRCS: DEFINED_VERSION.
26
define( 'WC_STRIPE_MIN_PHP_VER', '5.6.0' );
27
define( 'WC_STRIPE_MIN_WC_VER', '3.0' );
28
define( 'WC_STRIPE_FUTURE_MIN_WC_VER', '3.0' );
29
define( 'WC_STRIPE_MAIN_FILE', __FILE__ );
30
define( 'WC_STRIPE_PLUGIN_URL', untrailingslashit( plugins_url( basename( plugin_dir_path( __FILE__ ) ), basename( __FILE__ ) ) ) );
31
define( 'WC_STRIPE_PLUGIN_PATH', untrailingslashit( plugin_dir_path( __FILE__ ) ) );
32
33
// phpcs:disable WordPress.Files.FileName
34
35
/**
36
 * WooCommerce fallback notice.
37
 *
38
 * @since 4.1.2
39
 * @return string
40
 */
41
function woocommerce_stripe_missing_wc_notice() {
42
	/* translators: 1. URL link. */
43
	echo '<div class="error"><p><strong>' . sprintf( esc_html__( 'Stripe requires WooCommerce to be installed and active. You can download %s here.', 'woocommerce-gateway-stripe' ), '<a href="https://woocommerce.com/" target="_blank">WooCommerce</a>' ) . '</strong></p></div>';
44
}
45
46
/**
47
 * WooCommerce not supported fallback notice.
48
 *
49
 * @since 4.4.0
50
 * @return string
51
 */
52
function woocommerce_stripe_wc_not_supported() {
53
	/* translators: $1. Minimum WooCommerce version. $2. Current WooCommerce version. */
54
	echo '<div class="error"><p><strong>' . sprintf( esc_html__( 'Stripe requires WooCommerce %1$s or greater to be installed and active. WooCommerce %2$s is no longer supported.', 'woocommerce-gateway-stripe' ), WC_STRIPE_MIN_WC_VER, WC_VERSION ) . '</strong></p></div>';
55
}
56
57
function wc_stripe() {
58
59
	static $plugin;
60
61
	if ( ! isset( $plugin ) ) {
62
63
		class WC_Stripe {
64
65
			/**
66
			 * @var Singleton The reference the *Singleton* instance of this class
67
			 */
68
			private static $instance;
69
70
			/**
71
			 * Returns the *Singleton* instance of this class.
72
			 *
73
			 * @return Singleton The *Singleton* instance.
74
			 */
75
			public static function get_instance() {
76
				if ( null === self::$instance ) {
77
					self::$instance = new self();
0 ignored issues
show
Documentation Bug introduced by
It seems like new self() of type object<WC_Stripe> is incompatible with the declared type object<Singleton> of property $instance.

Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property.

Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property..

Loading history...
78
				}
79
				return self::$instance;
0 ignored issues
show
Bug Compatibility introduced by
The expression self::$instance; of type WC_Stripe|Singleton adds the type WC_Stripe to the return on line 79 which is incompatible with the return type documented by WC_Stripe::get_instance of type Singleton.
Loading history...
80
			}
81
82
			/**
83
			 * Stripe Connect API
84
			 *
85
			 * @var WC_Stripe_Connect_API
86
			 */
87
			private $api;
88
89
			/**
90
			 * Stripe Connect
91
			 *
92
			 * @var WC_Stripe_Connect
93
			 */
94
			public $connect;
95
96
			/**
97
			 * Private clone method to prevent cloning of the instance of the
98
			 * *Singleton* instance.
99
			 *
100
			 * @return void
101
			 */
102
			private function __clone() {}
103
104
			/**
105
			 * Private unserialize method to prevent unserializing of the *Singleton*
106
			 * instance.
107
			 *
108
			 * @return void
109
			 */
110
			private function __wakeup() {}
111
112
			/**
113
			 * Protected constructor to prevent creating a new instance of the
114
			 * *Singleton* via the `new` operator from outside of this class.
115
			 */
116
			private function __construct() {
117
				add_action( 'admin_init', array( $this, 'install' ) );
118
119
				$this->init();
120
121
				$this->api     = new WC_Stripe_Connect_API();
122
				$this->connect = new WC_Stripe_Connect( $this->api );
123
124
				add_action( 'rest_api_init', array( $this, 'register_connect_routes' ) );
125
			}
126
127
			/**
128
			 * Init the plugin after plugins_loaded so environment variables are set.
129
			 *
130
			 * @since 1.0.0
131
			 * @version 4.0.0
132
			 */
133
			public function init() {
134
				if ( is_admin() ) {
135
					require_once dirname( __FILE__ ) . '/includes/admin/class-wc-stripe-privacy.php';
136
				}
137
138
				require_once dirname( __FILE__ ) . '/includes/class-wc-stripe-exception.php';
139
				require_once dirname( __FILE__ ) . '/includes/class-wc-stripe-logger.php';
140
				require_once dirname( __FILE__ ) . '/includes/class-wc-stripe-helper.php';
141
				include_once dirname( __FILE__ ) . '/includes/class-wc-stripe-api.php';
142
				require_once dirname( __FILE__ ) . '/includes/abstracts/abstract-wc-stripe-payment-gateway.php';
143
				require_once dirname( __FILE__ ) . '/includes/class-wc-stripe-webhook-handler.php';
144
				require_once dirname( __FILE__ ) . '/includes/class-wc-stripe-sepa-payment-token.php';
145
				require_once dirname( __FILE__ ) . '/includes/class-wc-stripe-apple-pay-registration.php';
146
				require_once dirname( __FILE__ ) . '/includes/compat/class-wc-stripe-pre-orders-compat.php';
147
				require_once dirname( __FILE__ ) . '/includes/class-wc-gateway-stripe.php';
148
				require_once dirname( __FILE__ ) . '/includes/payment-methods/class-wc-gateway-stripe-bancontact.php';
149
				require_once dirname( __FILE__ ) . '/includes/payment-methods/class-wc-gateway-stripe-sofort.php';
150
				require_once dirname( __FILE__ ) . '/includes/payment-methods/class-wc-gateway-stripe-giropay.php';
151
				require_once dirname( __FILE__ ) . '/includes/payment-methods/class-wc-gateway-stripe-eps.php';
152
				require_once dirname( __FILE__ ) . '/includes/payment-methods/class-wc-gateway-stripe-ideal.php';
153
				require_once dirname( __FILE__ ) . '/includes/payment-methods/class-wc-gateway-stripe-p24.php';
154
				require_once dirname( __FILE__ ) . '/includes/payment-methods/class-wc-gateway-stripe-alipay.php';
155
				require_once dirname( __FILE__ ) . '/includes/payment-methods/class-wc-gateway-stripe-sepa.php';
156
				require_once dirname( __FILE__ ) . '/includes/payment-methods/class-wc-gateway-stripe-multibanco.php';
157
				require_once dirname( __FILE__ ) . '/includes/payment-methods/class-wc-stripe-payment-request.php';
158
				require_once dirname( __FILE__ ) . '/includes/compat/class-wc-stripe-subs-compat.php';
159
				require_once dirname( __FILE__ ) . '/includes/compat/class-wc-stripe-sepa-subs-compat.php';
160
				require_once dirname( __FILE__ ) . '/includes/connect/class-wc-stripe-connect.php';
161
				require_once dirname( __FILE__ ) . '/includes/connect/class-wc-stripe-connect-api.php';
162
				require_once dirname( __FILE__ ) . '/includes/class-wc-stripe-order-handler.php';
163
				require_once dirname( __FILE__ ) . '/includes/class-wc-stripe-payment-tokens.php';
164
				require_once dirname( __FILE__ ) . '/includes/class-wc-stripe-customer.php';
165
				require_once dirname( __FILE__ ) . '/includes/class-wc-stripe-intent-controller.php';
166
167
				if ( is_admin() ) {
168
					require_once dirname( __FILE__ ) . '/includes/admin/class-wc-stripe-admin-notices.php';
169
				}
170
171
				// REMOVE IN THE FUTURE.
172
				require_once dirname( __FILE__ ) . '/includes/deprecated/class-wc-stripe-apple-pay.php';
173
174
				add_filter( 'woocommerce_payment_gateways', array( $this, 'add_gateways' ) );
175
				add_filter( 'plugin_action_links_' . plugin_basename( __FILE__ ), array( $this, 'plugin_action_links' ) );
176
				add_filter( 'plugin_row_meta', array( $this, 'plugin_row_meta' ), 10, 2 );
177
178
				// Modify emails emails.
179
				add_filter( 'woocommerce_email_classes', array( $this, 'add_emails' ), 20 );
180
181
				if ( version_compare( WC_VERSION, '3.4', '<' ) ) {
182
					add_filter( 'woocommerce_get_sections_checkout', array( $this, 'filter_gateway_order_admin' ) );
183
				}
184
			}
185
186
			/**
187
			 * Updates the plugin version in db
188
			 *
189
			 * @since 3.1.0
190
			 * @version 4.0.0
191
			 */
192
			public function update_plugin_version() {
193
				delete_option( 'wc_stripe_version' );
194
				update_option( 'wc_stripe_version', WC_STRIPE_VERSION );
195
			}
196
197
			/**
198
			 * Handles upgrade routines.
199
			 *
200
			 * @since 3.1.0
201
			 * @version 3.1.0
202
			 */
203
			public function install() {
204
				if ( ! is_plugin_active( plugin_basename( __FILE__ ) ) ) {
205
					return;
206
				}
207
208
				if ( ! defined( 'IFRAME_REQUEST' ) && ( WC_STRIPE_VERSION !== get_option( 'wc_stripe_version' ) ) ) {
209
					do_action( 'woocommerce_stripe_updated' );
210
211
					if ( ! defined( 'WC_STRIPE_INSTALLING' ) ) {
212
						define( 'WC_STRIPE_INSTALLING', true );
213
					}
214
215
					$this->update_plugin_version();
216
				}
217
			}
218
219
			/**
220
			 * Add plugin action links.
221
			 *
222
			 * @since 1.0.0
223
			 * @version 4.0.0
224
			 */
225
			public function plugin_action_links( $links ) {
226
				$plugin_links = array(
227
					'<a href="admin.php?page=wc-settings&tab=checkout&section=stripe">' . esc_html__( 'Settings', 'woocommerce-gateway-stripe' ) . '</a>',
228
				);
229
				return array_merge( $plugin_links, $links );
230
			}
231
232
			/**
233
			 * Add plugin action links.
234
			 *
235
			 * @since 4.3.4
236
			 * @param  array  $links Original list of plugin links.
237
			 * @param  string $file  Name of current file.
238
			 * @return array  $links Update list of plugin links.
239
			 */
240
			public function plugin_row_meta( $links, $file ) {
241
				if ( plugin_basename( __FILE__ ) === $file ) {
242
					$row_meta = array(
243
						'docs'    => '<a href="' . esc_url( apply_filters( 'woocommerce_gateway_stripe_docs_url', 'https://docs.woocommerce.com/document/stripe/' ) ) . '" title="' . esc_attr( __( 'View Documentation', 'woocommerce-gateway-stripe' ) ) . '">' . __( 'Docs', 'woocommerce-gateway-stripe' ) . '</a>',
244
						'support' => '<a href="' . esc_url( apply_filters( 'woocommerce_gateway_stripe_support_url', 'https://woocommerce.com/my-account/create-a-ticket?select=18627' ) ) . '" title="' . esc_attr( __( 'Open a support request at WooCommerce.com', 'woocommerce-gateway-stripe' ) ) . '">' . __( 'Support', 'woocommerce-gateway-stripe' ) . '</a>',
245
					);
246
					return array_merge( $links, $row_meta );
247
				}
248
				return (array) $links;
249
			}
250
251
			/**
252
			 * Add the gateways to WooCommerce.
253
			 *
254
			 * @since 1.0.0
255
			 * @version 4.0.0
256
			 */
257
			public function add_gateways( $methods ) {
258
				if ( class_exists( 'WC_Subscriptions_Order' ) && function_exists( 'wcs_create_renewal_order' ) ) {
259
					$methods[] = 'WC_Stripe_Subs_Compat';
260
					$methods[] = 'WC_Stripe_Sepa_Subs_Compat';
261
				} else {
262
					$methods[] = 'WC_Gateway_Stripe';
263
					$methods[] = 'WC_Gateway_Stripe_Sepa';
264
				}
265
266
				$methods[] = 'WC_Gateway_Stripe_Bancontact';
267
				$methods[] = 'WC_Gateway_Stripe_Sofort';
268
				$methods[] = 'WC_Gateway_Stripe_Giropay';
269
				$methods[] = 'WC_Gateway_Stripe_Eps';
270
				$methods[] = 'WC_Gateway_Stripe_Ideal';
271
				$methods[] = 'WC_Gateway_Stripe_P24';
272
				$methods[] = 'WC_Gateway_Stripe_Alipay';
273
				$methods[] = 'WC_Gateway_Stripe_Multibanco';
274
275
				return $methods;
276
			}
277
278
			/**
279
			 * Modifies the order of the gateways displayed in admin.
280
			 *
281
			 * @since 4.0.0
282
			 * @version 4.0.0
283
			 */
284
			public function filter_gateway_order_admin( $sections ) {
285
				unset( $sections['stripe'] );
286
				unset( $sections['stripe_bancontact'] );
287
				unset( $sections['stripe_sofort'] );
288
				unset( $sections['stripe_giropay'] );
289
				unset( $sections['stripe_eps'] );
290
				unset( $sections['stripe_ideal'] );
291
				unset( $sections['stripe_p24'] );
292
				unset( $sections['stripe_alipay'] );
293
				unset( $sections['stripe_sepa'] );
294
				unset( $sections['stripe_multibanco'] );
295
296
				$sections['stripe']            = 'Stripe';
297
				$sections['stripe_bancontact'] = __( 'Stripe Bancontact', 'woocommerce-gateway-stripe' );
298
				$sections['stripe_sofort']     = __( 'Stripe SOFORT', 'woocommerce-gateway-stripe' );
299
				$sections['stripe_giropay']    = __( 'Stripe Giropay', 'woocommerce-gateway-stripe' );
300
				$sections['stripe_eps']        = __( 'Stripe EPS', 'woocommerce-gateway-stripe' );
301
				$sections['stripe_ideal']      = __( 'Stripe iDeal', 'woocommerce-gateway-stripe' );
302
				$sections['stripe_p24']        = __( 'Stripe P24', 'woocommerce-gateway-stripe' );
303
				$sections['stripe_alipay']     = __( 'Stripe Alipay', 'woocommerce-gateway-stripe' );
304
				$sections['stripe_sepa']       = __( 'Stripe SEPA Direct Debit', 'woocommerce-gateway-stripe' );
305
				$sections['stripe_multibanco'] = __( 'Stripe Multibanco', 'woocommerce-gateway-stripe' );
306
307
				return $sections;
308
			}
309
310
			/**
311
			 * Adds the failed SCA auth email to WooCommerce.
312
			 *
313
			 * @param WC_Email[] $email_classes All existing emails.
314
			 * @return WC_Email[]
315
			 */
316
			public function add_emails( $email_classes ) {
317
				require_once WC_STRIPE_PLUGIN_PATH . '/includes/compat/class-wc-stripe-email-failed-authentication.php';
318
				require_once WC_STRIPE_PLUGIN_PATH . '/includes/compat/class-wc-stripe-email-failed-renewal-authentication.php';
319
				require_once WC_STRIPE_PLUGIN_PATH . '/includes/compat/class-wc-stripe-email-failed-preorder-authentication.php';
320
				require_once WC_STRIPE_PLUGIN_PATH . '/includes/compat/class-wc-stripe-email-failed-authentication-retry.php';
321
322
				// Add all emails, generated by the gateway.
323
				$email_classes['WC_Stripe_Email_Failed_Renewal_Authentication']  = new WC_Stripe_Email_Failed_Renewal_Authentication( $email_classes );
324
				$email_classes['WC_Stripe_Email_Failed_Preorder_Authentication'] = new WC_Stripe_Email_Failed_Preorder_Authentication( $email_classes );
325
				$email_classes['WC_Stripe_Email_Failed_Authentication_Retry'] = new WC_Stripe_Email_Failed_Authentication_Retry( $email_classes );
326
327
				return $email_classes;
328
			}
329
330
			/**
331
			 * Register Stripe connect rest routes.
332
			 */
333
			public function register_connect_routes() {
334
335
				require_once WC_STRIPE_PLUGIN_PATH . '/includes/abstracts/abstract-wc-stripe-connect-rest-controller.php';
336
				require_once WC_STRIPE_PLUGIN_PATH . '/includes/connect/class-wc-stripe-connect-rest-oauth-init-controller.php';
337
				require_once WC_STRIPE_PLUGIN_PATH . '/includes/connect/class-wc-stripe-connect-rest-oauth-connect-controller.php';
338
339
				$oauth_init    = new WC_Stripe_Connect_REST_Oauth_Init_Controller( $this->connect, $this->api );
340
				$oauth_connect = new WC_Stripe_Connect_REST_Oauth_Connect_Controller( $this->connect, $this->api );
341
342
				$oauth_init->register_routes();
343
				$oauth_connect->register_routes();
344
			}
345
		}
346
347
		$plugin = WC_Stripe::get_instance();
348
349
	}
350
351
	return $plugin;
352
}
353
354
add_action( 'plugins_loaded', 'woocommerce_gateway_stripe_init' );
355
356
function woocommerce_gateway_stripe_init() {
357
	load_plugin_textdomain( 'woocommerce-gateway-stripe', false, plugin_basename( dirname( __FILE__ ) ) . '/languages' );
358
359
	if ( ! class_exists( 'WooCommerce' ) ) {
360
		add_action( 'admin_notices', 'woocommerce_stripe_missing_wc_notice' );
361
		return;
362
	}
363
364
	if ( version_compare( WC_VERSION, WC_STRIPE_MIN_WC_VER, '<' ) ) {
365
		add_action( 'admin_notices', 'woocommerce_stripe_wc_not_supported' );
366
		return;
367
	}
368
369
	wc_stripe();
370
}
371