class-wc-autoloader.php — WooCommerce 10.9.4

woocommerce / includes / class-wc-autoloader.php

woocommerce / includes Last commit date

class-wc-autoloader.php

182 lines

1	<?php
2	/**
3	* WooCommerce Autoloader.
4	*
5	* @package WooCommerce\Classes
6	* @version 2.3.0
7	*/
8
9	declare(strict_types=1);
10
11	defined( 'ABSPATH' ) \|\| exit;
12
13	use Automattic\WooCommerce\Admin\Features\Features;
14
15	/**
16	* Autoloader class.
17	*/
18	class WC_Autoloader {
19
20	/**
21	* Path to the includes directory.
22	*
23	* @var string
24	*/
25	private $include_path = '';
26
27	/**
28	* The Constructor.
29	*/
30	public function __construct() {
31	if ( function_exists( '__autoload' ) ) {
32	spl_autoload_register( '__autoload' );
33	}
34
35	spl_autoload_register( array( $this, 'autoload' ) );
36
37	$this->include_path = untrailingslashit( plugin_dir_path( WC_PLUGIN_FILE ) ) . '/includes/';
38	}
39
40	/**
41	* Take a class name and turn it into a file name.
42	*
43	* @param string $class Class name.
44	* @return string
45	*/
46	private function get_file_name_from_class( $class ) {
47	return 'class-' . str_replace( '_', '-', $class ) . '.php';
48	}
49
50	/**
51	* Include a class file.
52	*
53	* @param string $path File path.
54	* @return bool Successful or not.
55	*/
56	private function load_file( $path ) {
57	if ( $path && is_readable( $path ) ) {
58	include_once $path;
59	return true;
60	}
61	return false;
62	}
63
64	/**
65	* Auto-load WC classes on demand to reduce memory consumption.
66	*
67	* @param string $class Class name.
68	*/
69	public function autoload( $class ) {
70	$class = strtolower( $class );
71
72	if ( 0 !== strpos( $class, 'wc_' ) ) {
73	return;
74	}
75
76	// The Legacy REST API was removed in WooCommerce 9.0, but some servers still have
77	// the includes/class-wc-api.php file after they upgrade, which causes a fatal error when executing
78	// "class_exists('WC_API')". This will prevent this error, while still making the class visible
79	// when it's provided by the WooCommerce Legacy REST API plugin.
80	if ( 'wc_api' === $class ) {
81	return;
82	}
83
84	// If the class is already loaded from a merged package, prevent autoloader from loading it as well.
85	if ( \Automattic\WooCommerce\Packages::should_load_class( $class ) ) {
86	return;
87	}
88
89	$file = $this->get_file_name_from_class( $class );
90	$path = '';
91
92	if ( 0 === strpos( $class, 'wc_addons_gateway_' ) ) {
93	$path = $this->include_path . 'gateways/' . substr( str_replace( '_', '-', $class ), 18 ) . '/';
94	} elseif ( 0 === strpos( $class, 'wc_gateway_' ) ) {
95	$path = $this->include_path . 'gateways/' . substr( str_replace( '_', '-', $class ), 11 ) . '/';
96	} elseif ( 0 === strpos( $class, 'wc_shipping_' ) ) {
97	$path = $this->include_path . 'shipping/' . substr( str_replace( '_', '-', $class ), 12 ) . '/';
98	} elseif ( 0 === strpos( $class, 'wc_shortcode_' ) ) {
99	$path = $this->include_path . 'shortcodes/';
100	} elseif ( 0 === strpos( $class, 'wc_meta_box' ) ) {
101	$path = $this->include_path . 'admin/meta-boxes/';
102	} elseif ( 0 === strpos( $class, 'wc_admin' ) ) {
103	$path = $this->include_path . 'admin/';
104	} elseif ( 0 === strpos( $class, 'wc_payment_token_' ) ) {
105	$path = $this->include_path . 'payment-tokens/';
106	} elseif ( 0 === strpos( $class, 'wc_log_handler_' ) ) {
107	$path = $this->include_path . 'log-handlers/';
108	} elseif ( 0 === strpos( $class, 'wc_integration' ) ) {
109	$path = $this->include_path . 'integrations/' . substr( str_replace( '_', '-', $class ), 15 ) . '/';
110	} elseif ( 0 === strpos( $class, 'wc_notes_' ) ) {
111	$path = $this->include_path . 'admin/notes/';
112	} elseif ( 0 === strpos( $class, 'wc_rest_' ) ) {
113	// Handle REST API controllers in subdirectories.
114	// For V4 controllers, check if the feature is enabled first.
115	if ( false !== strpos( $class, '_v4_' ) ) {
116	// Only load V4 controllers if the feature is enabled.
117	if ( Features::is_enabled( 'rest-api-v4' ) ) {
118	$rest_controller_paths = array(
119	'rest-api/Controllers/Version4/',
120	);
121
122	foreach ( $rest_controller_paths as $rest_path ) {
123	if ( $this->load_file( $this->include_path . $rest_path . $file ) ) {
124	return;
125	}
126	}
127
128	// Also check subdirectories recursively for V4.
129	$this->load_rest_v4_controller_recursively( $file );
130	}
131	} else {
132	// For non-V4 controllers, load normally.
133	$rest_controller_paths = array(
134	'rest-api/Controllers/Version1/',
135	'rest-api/Controllers/Version2/',
136	'rest-api/Controllers/Version3/',
137	'rest-api/Controllers/Telemetry/',
138	);
139
140	foreach ( $rest_controller_paths as $rest_path ) {
141	if ( $this->load_file( $this->include_path . $rest_path . $file ) ) {
142	return;
143	}
144	}
145	}
146	}
147
148	if ( empty( $path ) \|\| ! $this->load_file( $path . $file ) ) {
149	$this->load_file( $this->include_path . $file );
150	}
151	}
152
153	/**
154	* Recursively load REST API V4 controllers from subdirectories.
155	*
156	* @param string $file File name to search for.
157	*/
158	private function load_rest_v4_controller_recursively( $file ): bool {
159	$v4_base_path = $this->include_path . 'rest-api/Controllers/Version4/';
160
161	// Use RecursiveDirectoryIterator to search subdirectories.
162	if ( is_dir( $v4_base_path ) ) {
163	$iterator = new RecursiveIteratorIterator(
164	new RecursiveDirectoryIterator( $v4_base_path, RecursiveDirectoryIterator::SKIP_DOTS ),
165	RecursiveIteratorIterator::SELF_FIRST
166	);
167
168	foreach ( $iterator as $dir_info ) {
169	if ( $dir_info->isDir() ) {
170	$subdir_path = $dir_info->getPathname() . '/';
171	if ( $this->load_file( $subdir_path . $file ) ) {
172	return true;
173	}
174	}
175	}
176	}
177	return false;
178	}
179	}
180
181	new WC_Autoloader();
182