abstract-screen.php — Advanced Ads – Ad Manager & AdSense 2.0.24

advanced-ads / includes / abstracts / abstract-screen.php

advanced-ads / includes / abstracts Last commit date

abstract-ad.php 1 week ago abstract-admin-list-table.php 1 week ago abstract-data.php 1 week ago abstract-factory.php 1 week ago abstract-group.php 6 days ago abstract-placement-type.php 1 week ago abstract-placement.php 3 months ago abstract-screen.php 3 months ago abstract-types.php 1 week ago index.php 2 years ago

abstract-screen.php

245 lines

1	<?php
2	/**
3	* Abstracts Screen.
4	*
5	* @package AdvancedAds
6	* @author Advanced Ads <info@wpadvancedads.com>
7	* @since 1.47.0
8	*/
9
10	namespace AdvancedAds\Abstracts;
11
12	use AdvancedAds\Framework\Utilities\Str;
13	use AdvancedAds\Framework\Utilities\Params;
14
15	defined( 'ABSPATH' ) \|\| exit;
16
17	/**
18	* Abstracts Screen.
19	*/
20	abstract class Screen {
21
22	/**
23	* The hook assigned to the screen.
24	*
25	* @var string
26	*/
27	private $hook = '';
28
29	/**
30	* List of tabs for the screen.
31	*
32	* @var array
33	*/
34	private $tabs = [];
35
36	/* Page Hook Api --------------- */
37
38	/**
39	* Get the hook.
40	*
41	* @return string
42	*/
43	public function get_hook(): string {
44	return $this->hook;
45	}
46
47	/**
48	* Set the hook.
49	*
50	* @param string $hook Hook to set.
51	*
52	* @return void
53	*/
54	public function set_hook( string $hook ): void {
55	$this->hook = $hook;
56	}
57
58	/* Screen API ------------------ */
59
60	/**
61	* Screen unique id.
62	*
63	* @return string
64	*/
65	abstract public function get_id(): string;
66
67	/**
68	* Register screen into WordPress admin area.
69	*
70	* @return void
71	*/
72	abstract public function register_screen(): void;
73
74	/**
75	* Enqueue assets
76	*
77	* @return void
78	*/
79	public function enqueue_assets(): void {}
80
81	/**
82	* Display screen content.
83	*
84	* @return void
85	*/
86	public function display(): void {}
87
88	/**
89	* Get the order value.
90	*
91	* @return int The order value, which is 10.
92	*/
93	public function get_order(): int {
94	return 10;
95	}
96
97	/* Tabs API -------------------- */
98
99	/**
100	* Get the tabs.
101	*
102	* @return array
103	*/
104	public function get_tabs(): array {
105	return $this->tabs;
106	}
107
108	/**
109	* Set the tabs.
110	*
111	* @param array $tabs Array of screen tabs.
112	*
113	* @return void
114	*/
115	public function set_tabs( array $tabs ): void {
116	$this->tabs = apply_filters( 'advanced-ads-screen-tabs-' . $this->get_id(), $tabs );
117	}
118
119	/**
120	* Get current tab id.
121	*
122	* @return string
123	*/
124	public function get_current_tab_id(): string {
125	$first = current( array_keys( $this->tabs ) );
126
127	return Params::get( 'sub_page', $first );
128	}
129
130	/**
131	* Render tabs menu
132	*
133	* @param array $args Arguments to be used in the template.
134	*
135	* @return void
136	*/
137	public function get_tabs_menu( array $args = [] ): void { // phpcs:ignore
138	$tabs = $this->tabs;
139	$active = $this->get_current_tab_id();
140
141	include ADVADS_ABSPATH . 'views/admin/header-tabs.php';
142	}
143
144	/**
145	* Render tabs content
146	*
147	* @param array $args Arguments to be used in the template.
148	*
149	* @return void
150	*/
151	public function get_tab_content( array $args = [] ): void { // phpcs:ignore
152	$active = $this->get_current_tab_id();
153	$tab = $this->tabs[ $active ] ?? null;
154
155	if ( ! $tab ) {
156	return;
157	}
158
159	echo '<div class="advads-tab-content">';
160	if ( isset( $tab['callback'] ) ) {
161	call_user_func( $tab['callback'] );
162	} elseif ( isset( $tab['filename'] ) ) {
163	include $tab['filename'];
164	}
165
166	echo '</div>';
167	}
168
169	/* Header API ------------------ */
170
171	/**
172	* Get page header arguments
173	*
174	* @return array
175	*/
176	public function define_header_args(): array {
177	return [];
178	}
179
180	/**
181	* Add actions to the header
182	*
183	* @return void
184	*/
185	public function header_actions(): void {}
186
187	/**
188	* Get admin page header
189	*
190	* @param array $args Arguments to be used in the template.
191	*
192	* @return void
193	*/
194	public function get_header( array $args = [] ): void {
195	$args = wp_parse_args( $args, $this->get_header_args() );
196
197	extract( $args, EXTR_SKIP ); // phpcs:ignore WordPress.PHP.DontExtract.extract_extract
198
199	include ADVADS_ABSPATH . 'views/admin/layout/header.php';
200	}
201
202	/**
203	* Get page header arguments
204	*
205	* @return array
206	*/
207	public function get_header_args(): array {
208	$wp_screen = get_current_screen();
209	return wp_parse_args(
210	$this->define_header_args(),
211	[
212	'title' => get_admin_page_title(),
213	'breadcrumb_title' => get_admin_page_title(),
214	'breadcrumb' => true,
215	'manual_url' => $this->get_manual_url( '' ),
216	'screen' => $wp_screen,
217	]
218	);
219	}
220
221	/**
222	* Get manual url
223	*
224	* @param string $path Path to the manual page.
225	*
226	* @return string
227	*/
228	public function get_manual_url( string $path ): string {
229	$domain = 'https://wpadvancedads.com/manual/';
230
231	if ( Str::starts_with( 'http', $path ) ) {
232	$domain = '';
233	}
234
235	return add_query_arg(
236	[
237	'utm_source' => 'advanced-ads',
238	'utm_medium' => 'link',
239	'utm_campaign' => 'header-manual-' . $this->get_id(),
240	],
241	$domain . ltrim( $path, '/' )
242	);
243	}
244	}
245