class-autoloader.php — Advanced Ads – Ad Manager & AdSense 1.53.2

advanced-ads / includes / class-autoloader.php

advanced-ads / includes Last commit date

abstracts 2 years ago admin 1 year ago database 2 years ago groups 2 years ago installation 1 year ago interfaces 2 years ago traits 2 years ago utilities 2 years ago array_ad_conditions.php 3 years ago cap_map.php 3 years ago class-assets-registry.php 1 year ago class-autoloader.php 2 years ago class-entities.php 2 years ago class-plugin.php 1 year ago functions.php 3 years ago index.php 2 years ago load_modules.php 2 years ago

class-autoloader.php

187 lines

1	<?php
2	/**
3	* The class is responsible for locating and loading the autoloader file used in the plugin.
4	*
5	* @package AdvancedAds
6	* @author Advanced Ads <info@wpadvancedads.com>
7	* @since 1.47.0
8	*/
9
10	namespace AdvancedAds;
11
12	defined( 'ABSPATH' ) \|\| exit;
13
14	/**
15	* Autoloader.
16	*/
17	class Autoloader {
18
19	/**
20	* Hold autoloader.
21	*
22	* @var mixed
23	*/
24	private $autoloader;
25
26	/**
27	* Main instance
28	*
29	* Ensure only one instance is loaded or can be loaded.
30	*
31	* @return Autoloader
32	*/
33	public static function get(): Autoloader {
34	static $instance;
35
36	if ( null === $instance ) {
37	$instance = new Autoloader();
38	}
39
40	return $instance;
41	}
42
43	/**
44	* Get hold autoloader.
45	*
46	* @return mixed
47	*/
48	public function get_autoloader() {
49	return $this->autoloader;
50	}
51
52	/**
53	* Runs this initializer.
54	*
55	* @return void
56	*/
57	public function initialize(): void {
58	$locate = $this->locate();
59
60	if ( ! $locate ) {
61	add_action( 'admin_notices', [ $this, 'missing_autoloader' ] );
62	return;
63	}
64
65	$this->autoloader = require_once $locate;
66	$this->register_wordpress();
67	}
68
69	/**
70	* Locate the autoload file
71	*
72	* This function searches for the autoload file in the packages directory and vendor directory.
73	*
74	* @return bool\|string
75	*/
76	private function locate() {
77	$directory = dirname( ADVADS_FILE );
78	$packages = $directory . '/packages/autoload.php';
79	$vendors = $directory . '/vendor/autoload.php';
80	$is_debug = 'local' === ( function_exists( 'wp_get_environment_type' ) ? wp_get_environment_type() : $this->get_environment_type() );
81	$is_packages = is_readable( $packages );
82	$is_vendors = is_readable( $vendors );
83
84	if ( $is_packages && ( ! $is_debug \|\| ! $is_vendors ) ) {
85	return $packages;
86	}
87
88	if ( $is_vendors ) {
89	return $vendors;
90	}
91
92	return false;
93	}
94
95	/**
96	* Add WordPress classes to map
97	*
98	* @return void
99	*/
100	private function register_wordpress(): void {
101	$this->autoloader->addClassmap(
102	[
103	'WP_List_Table' => ABSPATH . 'wp-admin/includes/class-wp-list-table.php',
104	'WP_Terms_List_Table' => ABSPATH . 'wp-admin/includes/class-wp-terms-list-table.php',
105	]
106	);
107	}
108
109	/**
110	* If the autoloader is missing, add an admin notice.
111	*
112	* @return void
113	*/
114	protected function missing_autoloader(): void {
115	?>
116	<div class="notice notice-error">
117	<p>
118	<?php
119	printf(
120	/* translators: 1: is a link to a support document. 2: closing link */
121	esc_html__( 'Your installation of Advanced Ads is incomplete. If you installed Advanced Ads from GitHub, %1$s please refer to this document%2$s to set up your development environment.', 'advanced-ads' ),
122	'<a href="' . esc_url( 'https://github.com/advanced-ads/advanced-ads/wiki/How-to-set-up-development-environment' ) . '" target="_blank" rel="noopener noreferrer">',
123	'</a>'
124	);
125	?>
126	</p>
127	</div>
128	<?php
129	}
130
131	/**
132	* Retrieves the current environment type.
133	*
134	* @return string
135	*/
136	public function get_environment_type(): string {
137	static $current_env = '';
138
139	if ( ! defined( 'WP_RUN_CORE_TESTS' ) && $current_env ) {
140	return $current_env;
141	}
142
143	$wp_environments = [
144	'local',
145	'development',
146	'staging',
147	'production',
148	];
149
150	// Add a note about the deprecated WP_ENVIRONMENT_TYPES constant.
151	if ( defined( 'WP_ENVIRONMENT_TYPES' ) && function_exists( '_deprecated_argument' ) ) {
152	if ( function_exists( '__' ) ) {
153	/* translators: %s: WP_ENVIRONMENT_TYPES */
154	$message = sprintf( __( 'The %s constant is no longer supported.', 'advanced-ads' ), 'WP_ENVIRONMENT_TYPES' );
155	} else {
156	$message = sprintf( 'The %s constant is no longer supported.', 'WP_ENVIRONMENT_TYPES' );
157	}
158
159	_deprecated_argument(
160	'define()',
161	'5.5.1',
162	$message // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
163	);
164	}
165
166	// Check if the environment variable has been set, if `getenv` is available on the system.
167	if ( function_exists( 'getenv' ) ) {
168	$has_env = getenv( 'WP_ENVIRONMENT_TYPE' );
169	if ( false !== $has_env ) {
170	$current_env = $has_env;
171	}
172	}
173
174	// Fetch the environment from a constant, this overrides the global system variable.
175	if ( defined( 'WP_ENVIRONMENT_TYPE' ) && WP_ENVIRONMENT_TYPE ) {
176	$current_env = WP_ENVIRONMENT_TYPE;
177	}
178
179	// Make sure the environment is an allowed one, and not accidentally set to an invalid value.
180	if ( ! in_array( $current_env, $wp_environments, true ) ) {
181	$current_env = 'production';
182	}
183
184	return $current_env;
185	}
186	}
187