elementor / includes / autoloader.php

autoloader.php in Elementor Website Builder – more than just a page builder 3.28.0-dev2, at includes/autoloader.php

343 lines 9.5 KB

Raw Download Zip

1	<?php
2	namespace Elementor;
3
4	if ( ! defined( 'ABSPATH' ) ) {
5	exit; // Exit if accessed directly.
6	}
7
8	/**
9	* Elementor autoloader.
10	*
11	* Elementor autoloader handler class is responsible for loading the different
12	* classes needed to run the plugin.
13	*
14	* @since 1.6.0
15	*/
16	class Autoloader {
17
18	/**
19	* Classes map.
20	*
21	* Maps Elementor classes to file names.
22	*
23	* @since 1.6.0
24	* @access private
25	* @static
26	*
27	* @var array Classes used by elementor.
28	*/
29	private static $classes_map;
30
31	/**
32	* Classes aliases.
33	*
34	* Maps Elementor classes to aliases.
35	*
36	* @since 1.6.0
37	* @access private
38	* @static
39	*
40	* @var array Classes aliases.
41	*/
42	private static $classes_aliases;
43
44	/**
45	* Default path for autoloader.
46	*
47	* @var string
48	*/
49	private static $default_path;
50
51	/**
52	* Default namespace for autoloader.
53	*
54	* @var string
55	*/
56	private static $default_namespace;
57
58	/**
59	* Run autoloader.
60	*
61	* Register a function as `__autoload()` implementation.
62	*
63	* @param string $default_path
64	* @param string $default_namespace
65	*
66	* @since 1.6.0
67	* @access public
68	* @static
69	*/
70	public static function run( $default_path = '', $default_namespace = '' ) {
71	if ( '' === $default_path ) {
72	$default_path = ELEMENTOR_PATH;
73	}
74
75	if ( '' === $default_namespace ) {
76	$default_namespace = __NAMESPACE__;
77	}
78
79	self::$default_path = $default_path;
80	self::$default_namespace = $default_namespace;
81
82	spl_autoload_register( [ __CLASS__, 'autoload' ] );
83	}
84
85	/**
86	* Get classes aliases.
87	*
88	* Retrieve the classes aliases names.
89	*
90	* @since 1.6.0
91	* @access public
92	* @static
93	*
94	* @return array Classes aliases.
95	*/
96	public static function get_classes_aliases() {
97	if ( ! self::$classes_aliases ) {
98	self::init_classes_aliases();
99	}
100
101	return self::$classes_aliases;
102	}
103
104	public static function get_classes_map() {
105	if ( ! self::$classes_map ) {
106	self::init_classes_map();
107	}
108
109	return self::$classes_map;
110	}
111
112	private static function init_classes_map() {
113	self::$classes_map = [
114	'Api' => 'includes/api.php',
115	'Base_Control' => 'includes/controls/base.php',
116	'Base_Data_Control' => 'includes/controls/base-data.php',
117	'Base_UI_Control' => 'includes/controls/base-ui.php',
118	'Beta_Testers' => 'includes/beta-testers.php',
119	'Compatibility' => 'includes/compatibility.php',
120	'Conditions' => 'includes/conditions.php',
121	'Controls_Manager' => 'includes/managers/controls.php',
122	'Controls_Stack' => 'includes/base/controls-stack.php',
123	'Sub_Controls_Stack' => 'includes/base/sub-controls-stack.php',
124	'DB' => 'includes/db.php',
125	'Elements_Manager' => 'includes/managers/elements.php',
126	'Embed' => 'includes/embed.php',
127	'Fonts' => 'includes/fonts.php',
128	'Frontend' => 'includes/frontend.php',
129	'Group_Control_Base' => 'includes/controls/groups/base.php',
130	'Group_Control_Interface' => 'includes/interfaces/group-control.php',
131	'Has_Validation' => 'includes/interfaces/has-validation.php',
132	'Heartbeat' => 'includes/heartbeat.php',
133	'Images_Manager' => 'includes/managers/image.php',
134	'Maintenance' => 'includes/maintenance.php',
135	'Maintenance_Mode' => 'includes/maintenance-mode.php',
136	'Preview' => 'includes/preview.php',
137	'Rollback' => 'includes/rollback.php',
138	'Settings' => 'includes/settings/settings.php',
139	'Settings_Controls' => 'includes/settings/controls.php',
140	'Settings_Validations' => 'includes/settings/validations.php',
141	'Settings_Page' => 'includes/settings/settings-page.php',
142	'Shapes' => 'includes/shapes.php',
143	'Skins_Manager' => 'includes/managers/skins.php',
144	'Icons_Manager' => 'includes/managers/icons.php',
145	'Stylesheet' => 'includes/stylesheet.php',
146	'System_Info\Main' => 'includes/settings/system-info/main.php',
147	'TemplateLibrary\Classes\Import_Images' => 'includes/template-library/classes/class-import-images.php',
148	'TemplateLibrary\Forms\New_Template_Form' => 'includes/template-library/forms/new-template-form.php',
149	'TemplateLibrary\Manager' => 'includes/template-library/manager.php',
150	'TemplateLibrary\Source_Base' => 'includes/template-library/sources/base.php',
151	'TemplateLibrary\Source_Local' => 'includes/template-library/sources/local.php',
152	'TemplateLibrary\Source_Remote' => 'includes/template-library/sources/remote.php',
153	'TemplateLibrary\Source_Cloud' => 'includes/template-library/sources/cloud.php',
154	'Tools' => 'includes/settings/tools.php',
155	'Container\Container' => 'includes/container/container.php',
156	'Tracker' => 'includes/tracker.php',
157	'User' => 'includes/user.php',
158	'Utils' => 'includes/utils.php',
159	'Widget_WordPress' => 'includes/widgets/wordpress.php',
160	'Widgets_Manager' => 'includes/managers/widgets.php',
161	'WordPress_Widgets_Manager' => 'includes/managers/wordpress-widgets.php',
162	];
163
164	$controls_names = Controls_Manager::get_controls_names();
165
166	$controls_names = array_merge( $controls_names, [
167	'base_multiple',
168	'base_units',
169	] );
170
171	foreach ( $controls_names as $control_name ) {
172	$class_name = 'Control_' . self::normalize_class_name( $control_name, '_' );
173
174	self::$classes_map[ $class_name ] = 'includes/controls/' . str_replace( '_', '-', $control_name ) . '.php';
175	}
176
177	$controls_groups_names = Controls_Manager::get_groups_names();
178
179	foreach ( $controls_groups_names as $group_name ) {
180	$class_name = 'Group_Control_' . self::normalize_class_name( $group_name, '_' );
181
182	self::$classes_map[ $class_name ] = 'includes/controls/groups/' . $group_name . '.php';
183	}
184	}
185
186	/**
187	* Normalize Class Name
188	*
189	* Used to convert control names to class names.
190	*
191	* @param string $string
192	* @param string $delimiter
193	*
194	* @return mixed
195	*/
196	private static function normalize_class_name( $string, $delimiter = ' ' ) {
197	return ucwords( str_replace( '-', '_', $string ), $delimiter );
198	}
199
200	/**
201	* Init classes aliases.
202	*
203	* When Elementor classes renamed or moved to different folders, developers
204	* can still use the old names by setting an alias.
205	*
206	* While in deprecation period both classes will work. When the deprecation
207	* period ends, the alies should be removed from the list of aliases.
208	*
209	* Usage:
210	*
211	* self::$classes_aliases = [
212	* 'Namespace\OldClassName' => [
213	* 'replacement' => 'Namespace\NewClassName',
214	* 'version' => '3.0.0',
215	* ],
216	* 'Namespace\OldModule\ClassName' => [
217	* 'replacement' => 'Namespace\NewModule\ClassName',
218	* 'version' => '3.5.0',
219	* ],
220	* ];
221	*
222	* @access private
223	* @static
224	*
225	* @return void
226	*/
227	private static function init_classes_aliases() {
228	self::$classes_aliases = [
229	'System_Info\Main' => [
230	'replacement' => 'Modules\System_Info\Module',
231	'version' => '2.9.0',
232	],
233	'System_Info\Classes\Abstracts\Base_Reporter' => [
234	'replacement' => 'Modules\System_Info\Reporters\Base',
235	'version' => '2.9.0',
236	],
237	'System_Info\Classes\Server_Reporter' => [
238	'replacement' => 'Modules\System_Info\Reporters\Server',
239	'version' => '2.9.0',
240	],
241	'System_Info\Classes\MU_Plugins_Reporter' => [
242	'replacement' => 'Modules\System_Info\Reporters\MU_Plugins',
243	'version' => '2.9.0',
244	],
245	'System_Info\Classes\Network_Plugins_Reporter' => [
246	'replacement' => 'Modules\System_Info\Reporters\Network_Plugins',
247	'version' => '2.9.0',
248	],
249	'System_Info\Classes\Plugins_Reporter' => [
250	'replacement' => 'Modules\System_Info\Reporters\Plugins',
251	'version' => '2.9.0',
252	],
253	'System_Info\Classes\Theme_Reporter' => [
254	'replacement' => 'Modules\System_Info\Reporters\Theme',
255	'version' => '2.9.0',
256	],
257	'System_Info\Classes\User_Reporter' => [
258	'replacement' => 'Modules\System_Info\Reporters\User',
259	'version' => '2.9.0',
260	],
261	'System_Info\Helpers\Model_Helper' => [
262	'replacement' => 'Modules\System_Info\Helpers\Model_Helper',
263	'version' => '2.9.0',
264	],
265	];
266	}
267
268	/**
269	* Load class.
270	*
271	* For a given class name, require the class file.
272	*
273	* @since 1.6.0
274	* @access private
275	* @static
276	*
277	* @param string $relative_class_name Class name.
278	*/
279	private static function load_class( $relative_class_name ) {
280	$classes_map = self::get_classes_map();
281
282	if ( isset( $classes_map[ $relative_class_name ] ) ) {
283	$filename = self::$default_path . '/' . $classes_map[ $relative_class_name ];
284	} else {
285	$filename = strtolower(
286	preg_replace(
287	[ '/([a-z])([A-Z])/', '/_/', '/\\\/' ],
288	[ '$1-$2', '-', DIRECTORY_SEPARATOR ],
289	$relative_class_name
290	)
291	);
292
293	$filename = self::$default_path . $filename . '.php';
294	}
295
296	if ( is_readable( $filename ) ) {
297	require $filename;
298	}
299	}
300
301	/**
302	* Autoload.
303	*
304	* For a given class, check if it exist and load it.
305	*
306	* @since 1.6.0
307	* @access private
308	* @static
309	*
310	* @param string $class Class name.
311	*/
312	private static function autoload( $class ) {
313	if ( 0 !== strpos( $class, self::$default_namespace . '\\' ) ) {
314	return;
315	}
316
317	$relative_class_name = preg_replace( '/^' . self::$default_namespace . '\\\/', '', $class );
318
319	$classes_aliases = self::get_classes_aliases();
320
321	$has_class_alias = isset( $classes_aliases[ $relative_class_name ] );
322
323	// Backward Compatibility: Save old class name for set an alias after the new class is loaded.
324	if ( $has_class_alias ) {
325	$alias_data = $classes_aliases[ $relative_class_name ];
326
327	$relative_class_name = $alias_data['replacement'];
328	}
329
330	$final_class_name = self::$default_namespace . '\\' . $relative_class_name;
331
332	if ( ! class_exists( $final_class_name ) ) {
333	self::load_class( $relative_class_name );
334	}
335
336	if ( $has_class_alias ) {
337	class_alias( $final_class_name, $class );
338
339	Utils::handle_deprecation( $class, $alias_data['version'], $final_class_name );
340	}
341	}
342	}
343