class-plugin.php — Advanced Ads – Ad Manager & AdSense 2.0.3

advanced-ads / includes / class-plugin.php

advanced-ads / includes Last commit date

class-plugin.php

359 lines

1	<?php
2	/**
3	* The plugin bootstrap.
4	*
5	* @package AdvancedAds
6	* @author Advanced Ads <info@wpadvancedads.com>
7	* @since 1.47.0
8	*/
9
10	namespace AdvancedAds;
11
12	use AdvancedAds\Ads\Ads;
13	use AdvancedAds\Groups\Groups;
14	use Advanced_Ads_Admin_Licenses;
15	use AdvancedAds\Installation\Install;
16	use AdvancedAds\Placements\Placements;
17
18	defined( 'ABSPATH' ) \|\| exit;
19
20	/**
21	* Plugin.
22	*
23	* Containers:
24	*
25	* @property Shortcodes $shortcodes Shortcodes handler.
26	* @property Assets_Registry $registry Assets registry.
27	* @property Framework\JSON $json JSON handler.
28	* @property Admin\Admin_Menu $screens Admin screens.
29	* @property Frontend\Ad_Renderer $renderer Ads renderer.
30	* @property Frontend\Manager $frontend Frontend manager.
31	* @property Importers\Manager $importers Importers manager.
32	*/
33	class Plugin extends Framework\Loader {
34
35	use Traits\Extras;
36
37	/**
38	* The ads container
39	*
40	* @var Ads
41	*/
42	public $ads = null;
43
44	/**
45	* The groups container
46	*
47	* @var Groups
48	*/
49	public $groups = null;
50
51	/**
52	* The placements container
53	*
54	* @var Placements
55	*/
56	public $placements = null;
57
58	/**
59	* Modules manager
60	*
61	* @var Modules
62	*/
63	public $modules = null;
64
65	/**
66	* Main instance
67	*
68	* Ensure only one instance is loaded or can be loaded.
69	*
70	* @return Plugin
71	*/
72	public static function get(): Plugin {
73	static $instance;
74
75	if ( null === $instance ) {
76	$instance = new Plugin();
77	$instance->setup();
78	}
79
80	return $instance;
81	}
82
83	/**
84	* Get plugin version
85	*
86	* @return string
87	*/
88	public function get_version(): string {
89	return ADVADS_VERSION;
90	}
91
92	/**
93	* Bootstrap plugin.
94	*
95	* @return void
96	*/
97	private function setup(): void {
98	$this->define_constants();
99	$this->includes_functions();
100	$this->includes();
101	$this->includes_rest();
102	$this->includes_admin();
103	$this->includes_frontend();
104	$this->includes_deprecated();
105
106	/**
107	* Old loading strategy
108	*
109	* TODO: need to remove it in future.
110	*/
111	// Public-Facing and Core Functionality.
112	\Advanced_Ads::get_instance();
113	\Advanced_Ads_ModuleLoader::loadModules( ADVADS_ABSPATH . 'modules/' ); // enable modules, requires base class.
114
115	if ( is_admin() ) {
116	Advanced_Ads_Admin_Licenses::get_instance();
117	}
118
119	add_action( 'init', [ $this, 'load_textdomain' ] );
120	add_action( 'plugins_loaded', [ $this, 'on_plugins_loaded' ], -1 );
121	add_action( 'widgets_init', [ $this, 'register_widgets' ] );
122
123	// Load it all.
124	$this->ads->initialize();
125	$this->groups->initialize();
126	$this->placements->initialize();
127	$this->modules->initialize();
128	$this->load();
129	}
130
131	/**
132	* Register the Advanced Ads classic Widget
133	*
134	* @return void
135	*/
136	public function register_widgets(): void {
137	register_widget( '\AdvancedAds\Widget' );
138	}
139
140	/**
141	* When WordPress has loaded all plugins, trigger the `advanced-ads-loaded` hook.
142	*
143	* @since 1.47.0
144	*
145	* @return void
146	*/
147	public function on_plugins_loaded(): void {
148	/**
149	* Action trigger after loading finished.
150	*
151	* @since 1.47.0
152	*/
153	do_action( 'advanced-ads-loaded' );
154	}
155
156	/**
157	* Load the plugin text domain for translation.
158	*
159	* @return void
160	*/
161	public function load_textdomain(): void {
162	$locale = get_user_locale();
163	$locale = apply_filters( 'plugin_locale', $locale, 'advanced-ads' );
164
165	unload_textdomain( 'advanced-ads' );
166	if ( false === load_textdomain( 'advanced-ads', WP_LANG_DIR . '/plugins/advanced-ads-' . $locale . '.mo' ) ) {
167	load_textdomain( 'advanced-ads', WP_LANG_DIR . '/advanced-ads/advanced-ads-' . $locale . '.mo' );
168	}
169
170	load_plugin_textdomain( 'advanced-ads', false, dirname( ADVADS_PLUGIN_BASENAME ) . '/languages' );
171	}
172
173	/**
174	* Define Advanced Ads constant
175	*
176	* @return void
177	*/
178	private function define_constants(): void {
179	$this->define( 'ADVADS_ABSPATH', dirname( ADVADS_FILE ) . '/' );
180	$this->define( 'ADVADS_PLUGIN_BASENAME', plugin_basename( ADVADS_FILE ) );
181	$this->define( 'ADVADS_BASE_URL', plugin_dir_url( ADVADS_FILE ) );
182	$this->define( 'ADVADS_SLUG', 'advanced-ads' );
183	// name for group & option in settings.
184	$this->define( 'ADVADS_SETTINGS_ADBLOCKER', 'advanced-ads-adblocker' );
185
186	// Deprecated Constants.
187	/**
188	* ADVADS_BASE
189	*
190	* @deprecated 1.47.0 use ADVADS_PLUGIN_BASENAME now.
191	*/
192	define( 'ADVADS_BASE', ADVADS_PLUGIN_BASENAME );
193
194	/**
195	* ADVADS_BASE_PATH
196	*
197	* @deprecated 1.47.0 use ADVADS_ABSPATH now.
198	*/
199	define( 'ADVADS_BASE_PATH', ADVADS_ABSPATH );
200
201	/**
202	* ADVADS_BASE_DIR
203	*
204	* @deprecated 1.47.0 Avoid global declaration of the constant used exclusively in `load_text_domain` function; use localized declaration instead.
205	*/
206	define( 'ADVADS_BASE_DIR', dirname( ADVADS_PLUGIN_BASENAME ) );
207
208	/**
209	* ADVADS_URL
210	*
211	* @deprecated 1.47.0 Deprecating the constant in favor of using the direct URL to circumvent costly `esc_url` function; please update code accordingly.
212	*/
213	define( 'ADVADS_URL', 'https://wpadvancedads.com/' );
214	}
215
216	/**
217	* Includes core files used in admin and on the frontend.
218	*
219	* @return void
220	*/
221	private function includes(): void {
222	$this->ads = new Ads();
223	$this->groups = new Groups();
224	$this->placements = new Placements();
225	$this->modules = new Modules();
226
227	// Common.
228	$this->register_initializer( Install::class );
229	$this->register_integration( Entities::class );
230	$this->register_integration( Assets_Registry::class, 'registry' );
231	$this->register_integration( Framework\JSON::class, 'json', [ 'advancedAds' ] );
232	$this->register_integration( Compatibility\Compatibility::class );
233	$this->register_integration( Compatibility\AAWP::class );
234	$this->register_integration( Compatibility\Peepso::class );
235	$this->register_integration( Post_Data::class );
236	$this->register_integration( Crons\Ads::class );
237	$this->register_integration( Shortcodes::class, 'shortcodes' );
238	$this->register_integration( Frontend\Debug_Ads::class );
239	}
240
241	/**
242	* Includes files used on the frontend.
243	*
244	* @return void
245	*/
246	private function includes_frontend(): void {
247	// Early bail!!
248	if ( is_admin() ) {
249	return;
250	}
251
252	$this->register_integration( Frontend\Ad_Renderer::class, 'renderer' );
253	$this->register_integration( Frontend\Manager::class, 'frontend' );
254	$this->register_integration( Frontend\Scripts::class );
255	}
256
257	/**
258	* Includes files used in admin.
259	*
260	* @return void
261	*/
262	private function includes_admin(): void {
263	// Early bail!!
264	if ( ! is_admin() ) {
265	return;
266	}
267
268	$this->register_integration( Compatibility\Capability_Manager::class );
269	$this->register_initializer( Upgrades::class );
270	$this->register_integration( Admin\Action_Links::class );
271	$this->register_integration( Admin\Admin_Menu::class, 'screens' );
272	$this->register_integration( Admin\Admin_Notices::class );
273	$this->register_integration( Admin\Assets::class );
274	$this->register_integration( Admin\Header::class );
275	$this->register_integration( Admin\Marketing::class );
276	$this->register_integration( Admin\Metabox_Ad::class );
277	$this->register_integration( Admin\Metabox_Ad_Settings::class );
278	$this->register_integration( Admin\Post_Types::class );
279	$this->register_integration( Admin\Screen_Options::class );
280	$this->register_integration( Admin\Shortcode_Creator::class );
281	$this->register_integration( Admin\TinyMCE::class );
282	$this->register_integration( Admin\WordPress_Dashboard::class );
283	$this->register_integration( Admin\Quick_Bulk_Edit::class );
284	$this->register_integration( Admin\Page_Quick_Edit::class );
285	$this->register_integration( Admin\Placement_Quick_Edit::class );
286	$this->register_integration( Importers\Manager::class, 'importers' );
287	$this->register_integration( Admin\AJAX::class );
288	$this->register_integration( Admin\Version_Control::class );
289	$this->register_integration( Admin\Upgrades::class );
290	$this->register_integration( Admin\Authors::class );
291	$this->register_integration( Admin\Settings::class );
292	$this->register_integration( Admin\Misc::class );
293	$this->register_integration( Admin\Post_List::class );
294	$this->register_integration( Admin\Placement\Bulk_Edit::class );
295
296	if ( ! wp_doing_ajax() ) {
297	$this->register_integration( Admin\List_Filters::class, 'list_filters' );
298	}
299	}
300
301	/**
302	* Includes rest api files used in admin and on the frontend.
303	*
304	* @return void
305	*/
306	private function includes_rest(): void {
307	$this->register_route( Rest\Groups::class );
308	$this->register_route( Rest\Quick_Edit::class );
309	$this->register_route( Rest\Page_Quick_Edit::class );
310	$this->register_route( Rest\Placements::class );
311	$this->register_route( Rest\OnBoarding::class );
312	$this->register_route( Rest\Utilities::class );
313	}
314
315	/**
316	* Includes the necessary functions files.
317	*
318	* @return void
319	*/
320	private function includes_functions(): void {
321	require_once ADVADS_ABSPATH . 'includes/functions.php';
322	require_once ADVADS_ABSPATH . 'includes/functions-core.php';
323	require_once ADVADS_ABSPATH . 'includes/functions-conditional.php';
324	require_once ADVADS_ABSPATH . 'includes/functions-ad.php';
325	require_once ADVADS_ABSPATH . 'includes/functions-group.php';
326	require_once ADVADS_ABSPATH . 'includes/functions-placement.php';
327	require_once ADVADS_ABSPATH . 'includes/cap_map.php';
328	require_once ADVADS_ABSPATH . 'includes/default-hooks.php';
329	}
330
331	/**
332	* Includes deprecated files.
333	*
334	* @return void
335	*/
336	private function includes_deprecated(): void {
337	require_once ADVADS_ABSPATH . 'deprecated/ad_group.php';
338	require_once ADVADS_ABSPATH . 'deprecated/ad_placements.php';
339	require_once ADVADS_ABSPATH . 'deprecated/Ad_Repository.php';
340	require_once ADVADS_ABSPATH . 'deprecated/ad_type_abstract.php';
341	require_once ADVADS_ABSPATH . 'deprecated/ad_type_content.php';
342	require_once ADVADS_ABSPATH . 'deprecated/ad_type_dummy.php';
343	require_once ADVADS_ABSPATH . 'deprecated/ad_type_group.php';
344	require_once ADVADS_ABSPATH . 'deprecated/ad_type_image.php';
345	require_once ADVADS_ABSPATH . 'deprecated/ad_type_plain.php';
346	require_once ADVADS_ABSPATH . 'deprecated/ad-ajax.php';
347	require_once ADVADS_ABSPATH . 'deprecated/ad-debug.php';
348	require_once ADVADS_ABSPATH . 'deprecated/ad-expiration.php';
349	require_once ADVADS_ABSPATH . 'deprecated/ad-model.php';
350	require_once ADVADS_ABSPATH . 'deprecated/ad-select.php';
351	require_once ADVADS_ABSPATH . 'deprecated/ad.php';
352	require_once ADVADS_ABSPATH . 'deprecated/deprecated-functions.php';
353	require_once ADVADS_ABSPATH . 'deprecated/gadsense-dummy.php';
354	require_once ADVADS_ABSPATH . 'deprecated/Group_Repository.php';
355	require_once ADVADS_ABSPATH . 'deprecated/class-admin.php';
356	require_once ADVADS_ABSPATH . 'deprecated/class-advanced-ads-plugin.php';
357	}
358	}
359