Total Complexity | 69 |
Total Lines | 583 |
Duplicated Lines | 0 % |
Changes | 7 | ||
Bugs | 0 | Features | 1 |
Complex classes like WPInv_Plugin often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use WPInv_Plugin, and based on these observations, apply Extract Interface, too.
1 | <?php |
||
15 | class WPInv_Plugin { |
||
16 | |||
17 | /** |
||
18 | * GetPaid version. |
||
19 | * |
||
20 | * @var string |
||
21 | */ |
||
22 | public $version; |
||
23 | |||
24 | /** |
||
25 | * Data container. |
||
26 | * |
||
27 | * @var array |
||
28 | */ |
||
29 | protected $data = array(); |
||
30 | |||
31 | /** |
||
32 | * Form elements instance. |
||
33 | * |
||
34 | * @var WPInv_Payment_Form_Elements |
||
|
|||
35 | */ |
||
36 | public $form_elements; |
||
37 | |||
38 | /** |
||
39 | * @param array An array of payment gateways. |
||
40 | */ |
||
41 | public $gateways; |
||
42 | |||
43 | /** |
||
44 | * Class constructor. |
||
45 | */ |
||
46 | public function __construct() { |
||
47 | $this->define_constants(); |
||
48 | $this->includes(); |
||
49 | $this->init_hooks(); |
||
50 | $this->set_properties(); |
||
51 | } |
||
52 | |||
53 | /** |
||
54 | * Sets a custom data property. |
||
55 | * |
||
56 | * @param string $prop The prop to set. |
||
57 | * @param mixed $value The value to retrieve. |
||
58 | */ |
||
59 | public function set( $prop, $value ) { |
||
60 | $this->data[ $prop ] = $value; |
||
61 | } |
||
62 | |||
63 | /** |
||
64 | * Gets a custom data property. |
||
65 | * |
||
66 | * @param string $prop The prop to set. |
||
67 | * @return mixed The value. |
||
68 | */ |
||
69 | public function get( $prop ) { |
||
70 | |||
71 | if ( isset( $this->data[ $prop ] ) ) { |
||
72 | return $this->data[ $prop ]; |
||
73 | } |
||
74 | |||
75 | return null; |
||
76 | } |
||
77 | |||
78 | /** |
||
79 | * Define class properties. |
||
80 | */ |
||
81 | public function set_properties() { |
||
82 | |||
83 | // Sessions. |
||
84 | $this->set( 'session', new WPInv_Session_Handler() ); |
||
85 | $GLOBALS['wpi_session'] = $this->get( 'session' ); // Backwards compatibility. |
||
86 | $GLOBALS['wpinv_euvat'] = new WPInv_EUVat(); // Backwards compatibility. |
||
87 | |||
88 | // Init other objects. |
||
89 | $this->set( 'session', new WPInv_Session_Handler() ); |
||
90 | $this->set( 'notes', new WPInv_Notes() ); |
||
91 | $this->set( 'api', new WPInv_API() ); |
||
92 | $this->set( 'post_types', new GetPaid_Post_Types() ); |
||
93 | $this->set( 'template', new GetPaid_Template() ); |
||
94 | $this->set( 'admin', new GetPaid_Admin() ); |
||
95 | $this->set( 'subscriptions', new WPInv_Subscriptions() ); |
||
96 | $this->set( 'invoice_emails', new GetPaid_Invoice_Notification_Emails() ); |
||
97 | $this->set( 'subscription_emails', new GetPaid_Subscription_Notification_Emails() ); |
||
98 | $this->set( 'daily_maintenace', new GetPaid_Daily_Maintenance() ); |
||
99 | $this->set( 'payment_forms', new GetPaid_Payment_Forms() ); |
||
100 | $this->set( 'maxmind', new GetPaid_MaxMind_Geolocation() ); |
||
101 | |||
102 | } |
||
103 | |||
104 | /** |
||
105 | * Define plugin constants. |
||
106 | */ |
||
107 | public function define_constants() { |
||
108 | define( 'WPINV_PLUGIN_DIR', plugin_dir_path( WPINV_PLUGIN_FILE ) ); |
||
109 | define( 'WPINV_PLUGIN_URL', plugin_dir_url( WPINV_PLUGIN_FILE ) ); |
||
110 | $this->version = WPINV_VERSION; |
||
111 | } |
||
112 | |||
113 | /** |
||
114 | * Hook into actions and filters. |
||
115 | * |
||
116 | * @since 1.0.19 |
||
117 | */ |
||
118 | protected function init_hooks() { |
||
119 | /* Internationalize the text strings used. */ |
||
120 | add_action( 'plugins_loaded', array( &$this, 'plugins_loaded' ) ); |
||
121 | |||
122 | // Init the plugin after WordPress inits. |
||
123 | add_action( 'init', array( $this, 'init' ), 1 ); |
||
124 | add_action( 'init', array( $this, 'maybe_process_ipn' ), 10 ); |
||
125 | add_action( 'init', array( $this, 'wpinv_actions' ) ); |
||
126 | add_action( 'init', array( $this, 'maybe_do_authenticated_action' ), 100 ); |
||
127 | add_action( 'wp_enqueue_scripts', array( $this, 'enqueue_scripts' ), 11 ); |
||
128 | add_action( 'wp_footer', array( $this, 'wp_footer' ) ); |
||
129 | add_action( 'wp_head', array( $this, 'wp_head' ) ); |
||
130 | add_action( 'widgets_init', array( &$this, 'register_widgets' ) ); |
||
131 | add_filter( 'wpseo_exclude_from_sitemap_by_post_ids', array( $this, 'wpseo_exclude_from_sitemap_by_post_ids' ) ); |
||
132 | add_filter( 'pre_get_posts', array( &$this, 'pre_get_posts' ) ); |
||
133 | |||
134 | add_filter( 'query_vars', array( $this, 'custom_query_vars' ) ); |
||
135 | add_action( 'init', array( $this, 'add_rewrite_rule' ), 10, 0 ); |
||
136 | add_action( 'pre_get_posts', array( $this, 'maybe_process_new_ipn' ), 1 ); |
||
137 | |||
138 | // Fires after registering actions. |
||
139 | do_action( 'wpinv_actions', $this ); |
||
140 | do_action( 'getpaid_actions', $this ); |
||
141 | |||
142 | } |
||
143 | |||
144 | public function plugins_loaded() { |
||
153 | } |
||
154 | } |
||
155 | |||
156 | /** |
||
157 | * Load the translation of the plugin. |
||
158 | * |
||
159 | * @since 1.0 |
||
160 | */ |
||
161 | public function load_textdomain( $locale = NULL ) { |
||
176 | } |
||
177 | |||
178 | /** |
||
179 | * Include required core files used in admin and on the frontend. |
||
180 | */ |
||
181 | public function includes() { |
||
182 | |||
183 | // Start with the settings. |
||
184 | require_once( WPINV_PLUGIN_DIR . 'includes/admin/register-settings.php' ); |
||
185 | |||
186 | // Packages/libraries. |
||
187 | require_once( WPINV_PLUGIN_DIR . 'vendor/autoload.php' ); |
||
188 | require_once( WPINV_PLUGIN_DIR . 'vendor/ayecode/wp-ayecode-ui/ayecode-ui-loader.php' ); |
||
189 | |||
190 | // Load functions. |
||
191 | require_once( WPINV_PLUGIN_DIR . 'includes/deprecated-functions.php' ); |
||
192 | require_once( WPINV_PLUGIN_DIR . 'includes/wpinv-email-functions.php' ); |
||
193 | require_once( WPINV_PLUGIN_DIR . 'includes/wpinv-general-functions.php' ); |
||
194 | require_once( WPINV_PLUGIN_DIR . 'includes/wpinv-helper-functions.php' ); |
||
195 | require_once( WPINV_PLUGIN_DIR . 'includes/wpinv-tax-functions.php' ); |
||
196 | require_once( WPINV_PLUGIN_DIR . 'includes/wpinv-template-functions.php' ); |
||
197 | require_once( WPINV_PLUGIN_DIR . 'includes/wpinv-address-functions.php' ); |
||
198 | require_once( WPINV_PLUGIN_DIR . 'includes/invoice-functions.php' ); |
||
199 | require_once( WPINV_PLUGIN_DIR . 'includes/subscription-functions.php' ); |
||
200 | require_once( WPINV_PLUGIN_DIR . 'includes/wpinv-item-functions.php' ); |
||
201 | require_once( WPINV_PLUGIN_DIR . 'includes/wpinv-discount-functions.php' ); |
||
202 | require_once( WPINV_PLUGIN_DIR . 'includes/wpinv-gateway-functions.php' ); |
||
203 | require_once( WPINV_PLUGIN_DIR . 'includes/wpinv-payment-functions.php' ); |
||
204 | require_once( WPINV_PLUGIN_DIR . 'includes/user-functions.php' ); |
||
205 | require_once( WPINV_PLUGIN_DIR . 'includes/error-functions.php' ); |
||
206 | |||
207 | // Register autoloader. |
||
208 | try { |
||
209 | spl_autoload_register( array( $this, 'autoload' ), true ); |
||
210 | } catch ( Exception $e ) { |
||
211 | wpinv_error_log( $e->getMessage(), '', __FILE__, 149, true ); |
||
212 | } |
||
213 | |||
214 | require_once( WPINV_PLUGIN_DIR . 'includes/abstracts/abstract-wpinv-session.php' ); |
||
215 | require_once( WPINV_PLUGIN_DIR . 'includes/class-wpinv-session-handler.php' ); |
||
216 | require_once( WPINV_PLUGIN_DIR . 'includes/class-wpinv-ajax.php' ); |
||
217 | require_once( WPINV_PLUGIN_DIR . 'includes/class-wpinv-api.php' ); |
||
218 | require_once( WPINV_PLUGIN_DIR . 'includes/class-wpinv-cache-helper.php' ); |
||
219 | require_once( WPINV_PLUGIN_DIR . 'includes/class-wpinv-db.php' ); |
||
220 | require_once( WPINV_PLUGIN_DIR . 'includes/admin/subscriptions.php' ); |
||
221 | require_once( WPINV_PLUGIN_DIR . 'includes/class-wpinv-subscriptions-db.php' ); |
||
222 | require_once( WPINV_PLUGIN_DIR . 'includes/wpinv-subscription.php' ); |
||
223 | require_once( WPINV_PLUGIN_DIR . 'includes/abstracts/abstract-wpinv-privacy.php' ); |
||
224 | require_once( WPINV_PLUGIN_DIR . 'includes/class-wpinv-privacy.php' ); |
||
225 | require_once( WPINV_PLUGIN_DIR . 'includes/libraries/class-ayecode-addons.php' ); |
||
226 | require_once( WPINV_PLUGIN_DIR . 'includes/class-wpinv-addons.php' ); |
||
227 | require_once( WPINV_PLUGIN_DIR . 'widgets/checkout.php' ); |
||
228 | require_once( WPINV_PLUGIN_DIR . 'widgets/invoice-history.php' ); |
||
229 | require_once( WPINV_PLUGIN_DIR . 'widgets/invoice-receipt.php' ); |
||
230 | require_once( WPINV_PLUGIN_DIR . 'widgets/invoice-messages.php' ); |
||
231 | require_once( WPINV_PLUGIN_DIR . 'widgets/subscriptions.php' ); |
||
232 | require_once( WPINV_PLUGIN_DIR . 'widgets/buy-item.php' ); |
||
233 | require_once( WPINV_PLUGIN_DIR . 'widgets/getpaid.php' ); |
||
234 | require_once( WPINV_PLUGIN_DIR . 'includes/admin/admin-pages.php' ); |
||
235 | |||
236 | if ( is_admin() || ( defined( 'WP_CLI' ) && WP_CLI ) ) { |
||
237 | GetPaid_Post_Types_Admin::init(); |
||
238 | |||
239 | require_once( WPINV_PLUGIN_DIR . 'includes/admin/wpinv-admin-functions.php' ); |
||
240 | require_once( WPINV_PLUGIN_DIR . 'includes/admin/meta-boxes/class-mb-payment-form.php' ); |
||
241 | require_once( WPINV_PLUGIN_DIR . 'includes/admin/meta-boxes/class-mb-invoice-notes.php' ); |
||
242 | require_once( WPINV_PLUGIN_DIR . 'includes/admin/class-wpinv-admin-menus.php' ); |
||
243 | require_once( WPINV_PLUGIN_DIR . 'includes/admin/class-wpinv-users.php' ); |
||
244 | require_once( WPINV_PLUGIN_DIR . 'includes/admin/class-getpaid-admin-profile.php' ); |
||
245 | // load the user class only on the users.php page |
||
246 | global $pagenow; |
||
247 | if($pagenow=='users.php'){ |
||
248 | new WPInv_Admin_Users(); |
||
249 | } |
||
250 | } |
||
251 | |||
252 | // Register cli commands |
||
253 | if ( defined( 'WP_CLI' ) && WP_CLI ) { |
||
254 | require_once( WPINV_PLUGIN_DIR . 'includes/class-wpinv-cli.php' ); |
||
255 | WP_CLI::add_command( 'invoicing', 'WPInv_CLI' ); |
||
256 | } |
||
257 | |||
258 | } |
||
259 | |||
260 | /** |
||
261 | * Class autoloader |
||
262 | * |
||
263 | * @param string $class_name The name of the class to load. |
||
264 | * @access public |
||
265 | * @since 1.0.19 |
||
266 | * @return void |
||
267 | */ |
||
268 | public function autoload( $class_name ) { |
||
302 | } |
||
303 | |||
304 | } |
||
305 | |||
306 | } |
||
307 | |||
308 | /** |
||
309 | * Inits hooks etc. |
||
310 | */ |
||
311 | public function init() { |
||
312 | |||
313 | // Fires before getpaid inits. |
||
314 | do_action( 'before_getpaid_init', $this ); |
||
315 | |||
316 | // Maybe upgrade. |
||
317 | $this->maybe_upgrade_database(); |
||
318 | |||
319 | // Load default gateways. |
||
320 | $gateways = apply_filters( |
||
321 | 'getpaid_default_gateways', |
||
322 | array( |
||
323 | 'manual' => 'GetPaid_Manual_Gateway', |
||
324 | 'paypal' => 'GetPaid_Paypal_Gateway', |
||
325 | 'worldpay' => 'GetPaid_Worldpay_Gateway', |
||
326 | 'bank_transfer' => 'GetPaid_Bank_Transfer_Gateway', |
||
327 | 'authorizenet' => 'GetPaid_Authorize_Net_Gateway', |
||
328 | ) |
||
329 | ); |
||
330 | |||
331 | foreach ( $gateways as $id => $class ) { |
||
332 | $this->gateways[ $id ] = new $class(); |
||
333 | } |
||
334 | |||
335 | if ( 'yes' != get_option( 'wpinv_renamed_gateways' ) ) { |
||
336 | GetPaid_Installer::rename_gateways_label(); |
||
337 | update_option( 'wpinv_renamed_gateways', 'yes' ); |
||
338 | } |
||
339 | |||
340 | // Fires after getpaid inits. |
||
341 | do_action( 'getpaid_init', $this ); |
||
342 | |||
343 | } |
||
344 | |||
345 | /** |
||
346 | * Checks if this is an IPN request and processes it. |
||
347 | */ |
||
348 | public function maybe_process_ipn() { |
||
349 | |||
350 | // Ensure that this is an IPN request. |
||
351 | if ( empty( $_GET['wpi-listener'] ) || 'IPN' !== $_GET['wpi-listener'] || empty( $_GET['wpi-gateway'] ) ) { |
||
352 | return; |
||
353 | } |
||
354 | |||
355 | $gateway = wpinv_clean( $_GET['wpi-gateway'] ); |
||
356 | |||
357 | do_action( 'wpinv_verify_payment_ipn', $gateway ); |
||
358 | do_action( "wpinv_verify_{$gateway}_ipn" ); |
||
359 | exit; |
||
360 | |||
361 | } |
||
362 | |||
363 | public function enqueue_scripts() { |
||
364 | |||
365 | // Fires before adding scripts. |
||
366 | do_action( 'getpaid_enqueue_scripts' ); |
||
367 | |||
368 | $localize = array(); |
||
369 | $localize['ajax_url'] = admin_url( 'admin-ajax.php' ); |
||
370 | $localize['nonce'] = wp_create_nonce( 'wpinv-nonce' ); |
||
371 | $localize['txtComplete'] = __( 'Continue', 'invoicing' ); |
||
372 | $localize['UseTaxes'] = wpinv_use_taxes(); |
||
373 | $localize['formNonce'] = wp_create_nonce( 'getpaid_form_nonce' ); |
||
374 | $localize['loading'] = __( 'Loading...', 'invoicing' ); |
||
375 | $localize['connectionError'] = __( 'Could not establish a connection to the server.', 'invoicing' ); |
||
376 | |||
377 | $localize = apply_filters( 'wpinv_front_js_localize', $localize ); |
||
378 | |||
379 | $version = filemtime( WPINV_PLUGIN_DIR . 'assets/js/payment-forms.js' ); |
||
380 | wp_enqueue_script( 'wpinv-front-script', WPINV_PLUGIN_URL . 'assets/js/payment-forms.js', array( 'jquery' ), $version, true ); |
||
381 | wp_localize_script( 'wpinv-front-script', 'WPInv', $localize ); |
||
382 | } |
||
383 | |||
384 | public function wpinv_actions() { |
||
385 | if ( isset( $_REQUEST['wpi_action'] ) ) { |
||
386 | do_action( 'wpinv_' . wpinv_sanitize_key( $_REQUEST['wpi_action'] ), $_REQUEST ); |
||
387 | } |
||
388 | } |
||
389 | |||
390 | /** |
||
391 | * Fires an action after verifying that a user can fire them. |
||
392 | * |
||
393 | * Note: If the action is on an invoice, subscription etc, esure that the |
||
394 | * current user owns the invoice/subscription. |
||
395 | */ |
||
396 | public function maybe_do_authenticated_action() { |
||
407 | |||
408 | } |
||
409 | |||
410 | } |
||
411 | |||
412 | public function pre_get_posts( $wp_query ) { |
||
419 | } |
||
420 | |||
421 | /** |
||
422 | * Register widgets |
||
423 | * |
||
424 | */ |
||
425 | public function register_widgets() { |
||
426 | |||
427 | // Currently, UX Builder does not work particulaly well with SuperDuper. |
||
428 | // So we disable our widgets when editing a page with UX Builder. |
||
429 | if ( function_exists( 'ux_builder_is_active' ) && ux_builder_is_active() ) { |
||
430 | return; |
||
431 | } |
||
432 | |||
433 | $widgets = apply_filters( |
||
434 | 'getpaid_widget_classes', |
||
435 | array( |
||
436 | 'WPInv_Checkout_Widget', |
||
437 | 'WPInv_History_Widget', |
||
438 | 'WPInv_Receipt_Widget', |
||
439 | 'WPInv_Subscriptions_Widget', |
||
440 | 'WPInv_Buy_Item_Widget', |
||
441 | 'WPInv_Messages_Widget', |
||
442 | 'WPInv_GetPaid_Widget' |
||
443 | ) |
||
444 | ); |
||
445 | |||
446 | foreach ( $widgets as $widget ) { |
||
447 | register_widget( $widget ); |
||
448 | } |
||
449 | |||
450 | } |
||
451 | |||
452 | /** |
||
453 | * Upgrades the database. |
||
454 | * |
||
455 | * @since 2.0.2 |
||
456 | */ |
||
457 | public function maybe_upgrade_database() { |
||
458 | |||
459 | $wpi_version = get_option( 'wpinv_version', 0 ); |
||
460 | |||
461 | if ( $wpi_version == WPINV_VERSION ) { |
||
462 | return; |
||
463 | } |
||
464 | |||
465 | $installer = new GetPaid_Installer(); |
||
466 | |||
467 | if ( empty( $wpi_version ) ) { |
||
468 | return $installer->upgrade_db( 0 ); |
||
469 | } |
||
470 | |||
471 | $upgrades = array( |
||
472 | '0.0.5' => '004', |
||
473 | '1.0.3' => '102', |
||
474 | '2.0.0' => '118', |
||
475 | '2.0.8' => '207', |
||
476 | ); |
||
477 | |||
478 | foreach ( $upgrades as $key => $method ) { |
||
479 | |||
480 | if ( version_compare( $wpi_version, $key, '<' ) ) { |
||
481 | return $installer->upgrade_db( $method ); |
||
482 | } |
||
483 | |||
484 | } |
||
485 | |||
486 | } |
||
487 | |||
488 | /** |
||
489 | * Flushes the permalinks if needed. |
||
490 | * |
||
491 | * @since 2.0.8 |
||
492 | */ |
||
493 | public function maybe_flush_permalinks() { |
||
500 | } |
||
501 | |||
502 | } |
||
503 | |||
504 | /** |
||
505 | * Remove our pages from yoast sitemaps. |
||
506 | * |
||
507 | * @since 1.0.19 |
||
508 | * @param int[] $excluded_posts_ids |
||
509 | */ |
||
510 | public function wpseo_exclude_from_sitemap_by_post_ids( $excluded_posts_ids ){ |
||
511 | |||
512 | // Ensure that we have an array. |
||
513 | if ( ! is_array( $excluded_posts_ids ) ) { |
||
514 | $excluded_posts_ids = array(); |
||
515 | } |
||
516 | |||
517 | // Prepare our pages. |
||
518 | $our_pages = array(); |
||
519 | |||
520 | // Checkout page. |
||
521 | $our_pages[] = wpinv_get_option( 'checkout_page', false ); |
||
522 | |||
523 | // Success page. |
||
524 | $our_pages[] = wpinv_get_option( 'success_page', false ); |
||
525 | |||
526 | // Failure page. |
||
527 | $our_pages[] = wpinv_get_option( 'failure_page', false ); |
||
528 | |||
529 | // History page. |
||
530 | $our_pages[] = wpinv_get_option( 'invoice_history_page', false ); |
||
531 | |||
532 | // Subscriptions page. |
||
533 | $our_pages[] = wpinv_get_option( 'invoice_subscription_page', false ); |
||
534 | |||
535 | $our_pages = array_map( 'intval', array_filter( $our_pages ) ); |
||
536 | |||
537 | $excluded_posts_ids = $excluded_posts_ids + $our_pages; |
||
538 | return array_unique( $excluded_posts_ids ); |
||
539 | |||
540 | } |
||
541 | |||
542 | /** |
||
543 | * Displays additional footer code. |
||
544 | * |
||
545 | * @since 2.0.0 |
||
546 | */ |
||
547 | public function wp_footer() { |
||
549 | } |
||
550 | |||
551 | /** |
||
552 | * Displays additional header code. |
||
553 | * |
||
554 | * @since 2.0.0 |
||
555 | */ |
||
556 | public function wp_head() { |
||
558 | } |
||
559 | |||
560 | /** |
||
561 | * Custom query vars. |
||
562 | * |
||
563 | */ |
||
564 | public function custom_query_vars( $vars ) { |
||
565 | $vars[] = 'getpaid-ipn'; |
||
566 | return $vars; |
||
567 | } |
||
568 | |||
569 | /** |
||
570 | * Add rewrite tags and rules. |
||
571 | * |
||
572 | */ |
||
573 | public function add_rewrite_rule() { |
||
574 | $tag = 'getpaid-ipn'; |
||
575 | add_rewrite_tag( "%$tag%", '([^&]+)' ); |
||
576 | add_rewrite_rule( "^$tag/([^/]*)/?", "index.php?$tag=\$matches[1]",'top' ); |
||
577 | } |
||
578 | |||
579 | /** |
||
580 | * Processes non-query string ipns. |
||
581 | * |
||
582 | */ |
||
583 | public function maybe_process_new_ipn( $query ) { |
||
598 | |||
599 | } |
||
600 | |||
601 | } |
||
602 | |||
603 | } |
||
604 |
The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g.
excluded_paths: ["lib/*"]
, you can move it to the dependency path list as follows:For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths